Docbase 0 travis-ci Bower npm

Turn markdown docs into beautiful sites

Docbase

Build Status

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.

A rendered documentation site

Example Hubs built with Docbase

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

Installation

1. npm install -g yo

█████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒

2. npm install -g generator-docbase

██████████▒▒▒▒▒▒▒▒▒▒

3. yo docbase

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

...

████████████████████

Docbase 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

Send a PR with your name here.

History

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

Related Repositories

Docbase

Docbase

Turn markdown docs into beautiful sites ...

generator-docbase

generator-docbase

Docbase generator ...

docbase-js

docbase-js

DocBase API client for browser and node ...

docbase-manual

docbase-manual

Manual for docbase ...

grunt-docbase

grunt-docbase

Grunt plugin to generate html files from your docbase project. ...


Top Contributors

farhan687 mateusfreira henriquesa siddharthlatest StanleySathler

Dependencies

package version
dev grunt ~0.4.0
grunt-bump ^0.7.0
grunt-contrib-concat ^0.5.1
grunt-contrib-connect ^0.10.1
grunt-contrib-cssmin ^1.0.0
grunt-contrib-jasmine ^0.9.2
grunt-contrib-jshint ^0.11.2
grunt-contrib-uglify ^0.9.1
grunt-contrib-watch ^0.6.1
grunt-template-jasmine-istanbul ^0.4.0

Releases

-   v0.2.62 zip tar
-   v0.2.61 zip tar
-   v0.2.60 zip tar
-   v0.2.59 zip tar
-   v0.2.26 zip tar
-   v0.2.25 zip tar
-   v0.2.24 zip tar
-   v0.2.23 zip tar
-   v0.2.22 zip tar
-   v0.2.21 zip tar
-   v0.2.20 zip tar
-   v0.2.19 zip tar
-   v0.2.18 zip tar
-   v0.2.17 zip tar
-   v0.2.16 zip tar
-   v0.2.15 zip tar
-   v0.2.14 zip tar
-   v0.2.13 zip tar
-   v0.2.12 zip tar
-   v0.2.11 zip tar
-   v0.2.9 zip tar
-   v0.2.8 zip tar
-   v0.2.7 zip tar
-   v0.2.6 zip tar
-   v0.2.5 zip tar
-   v0.2.4 zip tar
-   v0.2.3 zip tar
-   v0.2.2 zip tar
-   v0.2.1 zip tar
-   1.0.0-rc1 zip tar