All Projects β†’ mrvautin β†’ Githubdocs

mrvautin / Githubdocs

Easily build a searchable documentation app using markdown files in your Github Repo or local Markdown files.

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Githubdocs

Hads
πŸ“š Markdown superpowered documentation for Node.js
Stars: ✭ 147 (+20.49%)
Mutual labels:  wiki, knowledgebase, markdown
Community
Modern Confluence alternative designed for internal & external docs, built with Golang + EmberJS
Stars: ✭ 1,286 (+954.1%)
Mutual labels:  wiki, knowledgebase
Angular Full Stack
Angular Full Stack project built using Angular, Express, Mongoose and Node. Whole stack in TypeScript.
Stars: ✭ 1,261 (+933.61%)
Mutual labels:  express, expressjs
Aaronvandenberg.nl
βš›οΈ Web Developers portfolio build with Gatsby.js & React.js
Stars: ✭ 98 (-19.67%)
Mutual labels:  express, expressjs
Node Express Postgresql Server
Basic Node with Express + PostgreSQL Server
Stars: ✭ 74 (-39.34%)
Mutual labels:  express, expressjs
Seafile
High performance file syncing and sharing, with also Markdown WYSIWYG editing, Wiki, file label and other knowledge management features.
Stars: ✭ 9,201 (+7441.8%)
Mutual labels:  wiki, markdown
Dataformsjs
🌟 DataFormsJS 🌟 A minimal JavaScript Framework and standalone React and Web Components for rapid development of high quality websites and single page applications.
Stars: ✭ 95 (-22.13%)
Mutual labels:  markdown, spa
Express Sequelize Crud
Simply expose resource CRUD (Create Read Update Delete) routes for Express & Sequelize. Compatible with React Admin Simple Rest Data Provider
Stars: ✭ 65 (-46.72%)
Mutual labels:  express, expressjs
Viki
A simple Wiki page in Markdown from notebook of VNote.
Stars: ✭ 103 (-15.57%)
Mutual labels:  wiki, markdown
Express Jwt
An example API for creating/verifying json web tokens
Stars: ✭ 105 (-13.93%)
Mutual labels:  express, expressjs
Mean Stack Angular5 Crud
MEAN Stack (Angular 5) CRUD Web Application Example
Stars: ✭ 107 (-12.3%)
Mutual labels:  express, expressjs
Mean Stack Angular6 Crud Example
MEAN Stack Angular 6 CRUD Web Application
Stars: ✭ 69 (-43.44%)
Mutual labels:  express, expressjs
Flowa
πŸ”₯Service level control flow for Node.js
Stars: ✭ 66 (-45.9%)
Mutual labels:  express, expressjs
Express Vue
Vue rendering engine for Express.js. Use .Vue files as templates using streams
Stars: ✭ 1,226 (+904.92%)
Mutual labels:  express, expressjs
Thinkdiff
My open source project links, programming and software development related code and tutorials are in this repo. Content types: Python, JavaScript, Dart | Django, React, Flutter, React-Native etc.
Stars: ✭ 65 (-46.72%)
Mutual labels:  express, expressjs
Balsa
This repository holds source code of Balsa, a self hosted, privacy focused knowledgebase.
Stars: ✭ 93 (-23.77%)
Mutual labels:  knowledgebase, markdown
Docx
Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.
Stars: ✭ 2,150 (+1662.3%)
Mutual labels:  express, expressjs
Mailman
Mailman is a GUI to help you manage your email accounts stored in a MySQL/MariaDB database.
Stars: ✭ 62 (-49.18%)
Mutual labels:  expressjs, spa
Mrdoc
online document system developed based on python. It is suitable for individuals and small teams to manage documents, wiki, knowledge and notes. like gitbook.
Stars: ✭ 1,129 (+825.41%)
Mutual labels:  wiki, markdown
Store Pos
Point of Sale Desktop App built with Electron
Stars: ✭ 103 (-15.57%)
Mutual labels:  express, expressjs

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:

{
    "title": "githubdocs",
    "githubRepoOwner": "mrvautin",
    "githubRepoName": "githubdocs",
    "githubRepoPath": "exampleDocs",
    "updateDocsCron": "*/5 * * * *",
    "addAnchors": true,
    "menuItems": [
        {
            "menuTitle": "About",
            "menuLink": "/about"
        },
        {
            "menuTitle": "Contact",
            "menuLink": "/contact"
        }
    ],
    "static": false
}
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 root of the repo holding the Markdown files
updateDocsCron A cron schedule to reindex your Markdown files/docs from Github or static
addAnchors Transforms H1, H2, H3, H4, H5 info HTML anchor points for easy sharing
menuItems Not sure how useful this is. Set the menu items in the top navigation
static Reads Markdown files statically from /docs folder. Defaults to false

Static websites

It's also possible to create a site from local Markdown files rather than using a Github repo.

Starting

You can start your website using the following command from the root of your app:

node app.js

Static

To do this you place your Markdown files into the docs folder and set static to true in your config.

An example config.json for a static site:

{
    "title": "githubdocs",
    "githubRepoOwner": "mrvautin",
    "githubRepoName": "githubdocs",
    "githubRepoPath": "exampleDocs",
    "updateDocsCron": "*/5 * * * *",
    "addAnchors": true,
    "menuItems": [
        {
            "menuTitle": "About",
            "menuLink": "/about"
        },
        {
            "menuTitle": "Contact",
            "menuLink": "/contact"
        }
    ],
    "static": true
}

Layouts

You can also specify your own layout file. The default views/layouts/layout.hbs file is used unless you specify a different file in your config.json.

{
    "layoutFile": "material.hbs"
}

Included is a material.hbs design template and a Bootstrap template (default.hbs).

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].