{"repo":"mrvautin/githubdocs","free":true,"listed":false,"github":"https://github.com/mrvautin/githubdocs","clone":"git clone https://github.com/mrvautin/githubdocs.git","description":"Easily build a searchable documentation app using markdown files in your Github Repo or local Markdown files.","language":"JavaScript","stars":142,"topics":["express","documenation","faq","knowledgebase","doco","expressjs","markdown","spa","wiki"],"license":null,"category":"productivity","readme_excerpt":"Githubdocs Easily build a searchable documentation Single Page Application (SPA) using markdown files in your Github Repo or local Markdown files. Github docs is a lightweight alternative to Gitbooks allowing simple but powerful Markdown generate documentation websites. Website from Github Repo Installation 1. Clone Repository: git clone https://github.com/mrvautin/githubdocs.git && cd githubdocs 2. Install dependencies: npm install 3. Start application: npm start 4. Go to http://127.0.0.1:5555 in your browser Demo https://githubdocs.markmoffat.com Markdown files The docs menu and files are built using files from your Github repo set in the config. Files should have the title of the doc in a single markdown hash/# (HTML = H1) tag in the file. This is used to build the slug of the doc and the menu title etc. See example docs here: https://github.com/mrvautin/githubdocs/tree/master/docs Search Search is built using js-search. The index is built and stored in memory on startup. When searched from the client the API is called returning any matching docs. The menu will then display the match docs. When the search term is removed, the full list of docs is returned. Config The config file is located here: /config/config.json . An example config: Setting Description --- --- title Sets the value to be displayed at the top of the page githubRepoOwner Owner/username of the Github repo githubRepoName Name of the repo holding the Markdown files githubRepoPath Directory relative to the roo","default_branch":null,"files":null,"tree":[],"storefront":"/r/mrvautin","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/mrvautin/githubdocs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}