GIT Playbook is a documentation framework that allows you to create Documentation for your project using Markdown and GH-Pages rapidly. This is the repository for Medium article Create compelling Documentation with Github Pages by Thomas Reinecke and Kai Wedekind.
- Runs your Markdown-based documentation on a webapp
- Mobile ready, responsive design
- supports any level of document hierarchy
- supports title, description & icon for every Folder & Document
- Live Search/Filtering capability keyword and topic-based (no server infrastructure necessary for it)
- All-In-One WebFrontend, only needs a webcontainer to run, optimized for deployment on GH Pages
- Left-Sided Tree Navigator
- Support for Multiple Playbooks in one app
- Breadcrumb Support to navigate through any level of the document hierarchy easily
- Topic Support to group documents together
- get started by reading the article Create compelling Documentation with Github Pages
- clone repository and follow the "Build Setup" instructions below
- edit "src/pageConfig.json" and change the document structure as you desire
- write your documents in Markdown and put them into the "static" folder
- create yourself a GIT repository and import your playbook trunk
- deploy it with
npm run gh-pages - in your GH repository > Settings > scroll down to "Github Pages", make sure it points to your "gh-pages" branch
- find the link to your GH page deployment on that screen aswell
- for feedback, enhancement requests or defect reports use "Issues" here on this repo
Enjoy!
# install dependencies
npm install
# serve with hot reload at localhost:8080
npm run dev
# build for production with minification, also build the search index
npm run build
# build the search index only
npm run build-search
# build for production and view the bundle analyzer report
npm run build --report
# run unit tests
npm run unit
# run e2e tests
npm run e2e
# run all tests
npm test
# deploy playbook to GH pages (includes build and deploy to GH pages)
npm run gh-pages