Code Monkey home page Code Monkey logo

docbase's Introduction

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

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

docbase's People

Contributors

farhan687 avatar henriquesa avatar mateusfreira avatar siddharthlatest avatar stanleysathler avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.