A git-based, flat-file CMS with a WYSIWYG editor that pulls documentation content from any repos you specify
Soon, this will be available as an npm package and a Docker image but, for right now, this is the way.
$ git clone https://github.com/flatgit/flatgit && cd flatgit
$ npm i
$ npm run serve
docker build -t <TAG> .
docker run -p <LOCAL>:8000 <TAG>
- Creation of config file for git repos and tokens
- Specifying repositories to pull from (supporting open source projects first and foremost)
- All files should be in
md
ortxt
and inside thedocs
folder - Consider supporting the
docs
branch that Github uses also
- All files should be in
- Webhook implementation to pull from repos when a change has been made
- Theming options for rendering content
- URL mapping from flatgit to documentation path
- Paths to files outside of the
docs/
folder should redirect to the source repo
- Paths to files outside of the
- Authentication (potentially through Oauth or tokens) to edit pages in browser
- Package and publish to npm