Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flatgit/flatgit
A git-based, flat-file CMS with a WYSIWYG editor that pulls documentation content from any repos you specify
https://github.com/flatgit/flatgit
Last synced: about 1 month ago
JSON representation
A git-based, flat-file CMS with a WYSIWYG editor that pulls documentation content from any repos you specify
- Host: GitHub
- URL: https://github.com/flatgit/flatgit
- Owner: flatgit
- License: gpl-3.0
- Created: 2019-05-10T08:51:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-05-15T19:26:14.000Z (over 5 years ago)
- Last Synced: 2024-08-01T12:31:50.032Z (4 months ago)
- Language: JavaScript
- Size: 70.3 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - flatgit/flatgit - A git-based, flat-file CMS with a WYSIWYG editor that pulls documentation content from any repos you specify (others)
README
# flatgit
A git-based, flat-file CMS with a WYSIWYG editor that pulls documentation content from any repos you specify
## Installation
Soon, this will be available as an npm package and a Docker image but, for right now, this is the way.
### Git
```
$ git clone https://github.com/flatgit/flatgit && cd flatgit
$ npm i
$ npm run serve
```
### Docker
```
docker build -t .
docker run -p :8000
```
## ROADMAP
* 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` or `txt` and inside the `docs` folder
* Consider supporting the `docs` branch that Github uses also
* 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
* Authentication (potentially through Oauth or tokens) to edit pages in browser
* Package and publish to npm