docugit
Serve documentation/wiki/KB from a Git-repo with markdown-files, see demo.
Installing / Getting started
Initial Configuration
Environment-Settings:
- git_api: path to git-api
- git_owner: name of owner of git-repo
- git_repo: name of git-repo
- git_branch: name of selected branch
- git_folder (optional): path of (sub)folder in repo to restrict navigation
Built with Angular and UIkit
This project was generated with Angular CLI version 11.2.6 and UIkit version 3.6.20.
Development server
Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
Code scaffolding
Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.
Build
Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
Running unit tests
Run ng test to execute the unit tests via Karma.
Running end-to-end tests
Run ng e2e to execute the end-to-end tests via Protractor.
Further help
To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.
Licensing
The code in this project is licensed under Apache-2.0 license.