Git Readme is a platform that helps teams publish and manage technical documentation. We know that documenting is hard, so we would like to simplify this process.
All documents are stored in your personal/team GitHub account. We only sync this files in order to index and provide a nice search experience.
You already have your development setup. Just use your favorite code editor and create documents using the already familiar markdown. If you are not a developer, don't worry, GitHub has a great markdown editor.
Having many pages of documents doesn't matter if you can't find what you need. Your search engine indexes every word so, hopefully, you will find every piece of information quickly.
As said before, Git Readme pulls all docs directly and automatically from GitHub. Just:
- Clone your template repository
- Install our app
- Commit your first change
And that's all. You website should be up and running test