appbaseio/Docbase

Name: Docbase

Owner: appbase.io

Description: Turn .md docs into beautiful sites

Created: 2015-02-09 17:16:35.0

Updated: 2018-05-06 15:58:23.0

Pushed: 2018-02-01 06:03:47.0

Homepage: https://appbaseio.github.io/Docbase

Size: 7613

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Docbase

We are no longer actively maintaining Docbase, we instead recommend using gatsbyjs.

Turn .md files into a beautiful documentation hub with versioning and beautifully rendered menus.

• Docbase can read files that are hosted on github, locally or a http:// server.
• It can publish documentation hubs to github pages (via travis) or locally which can be served with as static files with a http:// server.

Docbase comes with a yeoman generator that turns the installation and configuration process into a piece of cake.

Example Hubs built with Docbase

1. Airbnb JS Style guide
   
2. Redis Docs
   
3. EmberJS Guide

Installation

pm install -g yo

????????????????

pm install -g generator-docbase

????????????????

o docbase

ome to
.___           ___.
| _/____   ____\_ |__ _____    ______ ____
_ |/  _ \_/ ___\| __ \\__  \  /  ___// __ \
/ (  <_> )  \___| \_\ \/ __ \_\___ \\  ___/
_ |\____/ \___  >___  (____  /____  >\___  >
 \/           \/    \/     \/     \/     \/
    generator!



????????????????

ase is live at: http://127.0.0.1:1234

Read the manual

The manual walks through the generator options, and explains docbase options and features. The manual itself is served with docbase.

Who uses docbase

• appbase.io
• Reactive Maps

Send a PR with your name here.

History

v0.3.0 Feb 27 '17

• Phantom.js dependency upgrade
• Compatibility with Node v6.9.x
• Uses scroll in code blocks
• Fixes mobile read view
• Adds a feature to see other pages in the directory

v0.2.56 Apr 2 '16

• Comes with a yeoman generator yo docbase
• Resizable mobile navigation menu
• Realtime search with an offline search index
• No 404s when navigating to folders
• Updates markdown parser
• Show github contributors on each documentation page
• Colorful themes baked in

.
. (54 more releases)
.

v0.0.2 Aug 7 '15

• All flatdoc theme options supported
• Customizable root path

v0.0.1 Feb 10 '15

• Initial release

Credits

Henrique Sa (@henriquesa),
Mateus Freira (@mateusfreira),
Farhan Chauhan (@farhan687),
Siddharth Kothari (@siddharthlatest)

License

MIT