Giter VIP home page Giter VIP logo

docbase's Introduction

Docbase

Build Status NPM

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.

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.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

docbase's People

Contributors

farhan687 avatar henriquesa avatar mateusfreira avatar siddharthlatest avatar stanleysathler avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docbase's Issues

Erro generating page: build_html/index.html

When I perform the following steps I get an error in the console and a blank page is displayed when I hit the local site. Can't figure out if this is an issue with the product or not.

*) yo docbase
*) when prompted
*) For hosted option select 'Magic'
*) For publish option select 'Locally'
*) For color option select 'green'

...stuff is printed to console

Running "docbase:def" (docbase) task
starting
Erro generating page: build_html/index.html

Custom frontpage having issues while building for production

I want to set up a completely custom html page as a front page. I set indexHtml in docbaseConfig as ./html/custompage.html.

It is working fine in local machine. The front page is custom and the docs are in the default layout. However, when I push the changes, it timeout in travis ci.

No output has been received in the last 10m0s, this potentially indicates a stalled build or something wrong with the build itself.
Check the details on how to adjust your build configuration on: https://docs.travis-ci.com/user/common-build-problems/#Build-times-out-because-no-output-was-received
The build has been terminated

After going through grunt-docbase code, I added a #navbar-collapse and .map_folder for checkLoadedSelector and checkNavbar checks.

I also tried setting manual_override to true.

What am I missing. What is the correct way to set a custom front page?

Sidebar highlight doesn't work for html mode.

The code snippet below is responsible for showing the active section in the sidebar during a doc navigation. It's present in the SPA mode, but when grunt converts the page to html mode. We need to execute the following script on each page for highlighting to work:

var $window = $(window);
    var $document = $(document);
    $document.on('ready', function() {
      $("h2, h3").scrollagent(function(cid, pid, currentElement, previousElement) {
        if (pid) {
         $("[pref='#"+pid+"']").removeClass('active');
        }
        if (cid) {
          $("[pref='#"+cid+"']").addClass('active');
        }
      });
    });

It's originally present in the flatdoc's theme file, but we miss adding the JS while converting to html mode - https://github.com/appbaseio/Docs/blob/master/bower_components/flatdoc/theme-white/script.js#L9

Authentication for documenting private projects

How hard would it be to add a basic authentication layer? (ie: for documenting private git-hub projects on a GitHub pages site)

I realise the published documentation content/back-end files could still be accessed by an unauthenticated user by guessing their URLs, but a simple authentication mechanism on the front-end SPA would be sufficiently-secure for many private projects.

Ideally, authentication linked to GitHub would be awesome if it allowed access to the published documentation based on a user's permission to access the underlying documentation's GitHub repo.

(This is something I would be interested in contributing to, since most documentation systems are focused on public vs private documentation, and I'm still looking for a GitHub-centric alternative for documenting our team's private projects. )

Regards, Michael

UI changes

  • remove margin-right from strong title
  • apply padding only for code immediate after strong
  • first element p tag -> strong : make it title
  • remove style.css from generator
  • Strong title color changes to #999

Support html files

Would you consider supporting html in addition to markdown? This would make it easy to convert (or scrape) existing documentation sites for publishing using docbase.

How to set up a local version for development?

I want to develop locally before deploying to github. However, I'm getting error while trying to set it up.

  1. I did yo docbase to generate the project locally.
  2. npm install to install dependencies.
  3. Did npm install -g grunt-cli and npm install -g bower as stated in docs.
  4. Run grunt

However, I'm getting the following error.

Loading "GruntFile.js" tasks...ERROR
>> TypeError: First argument must be a string, Buffer, ArrayBuffer, Array, or array-like object.
Warning: Task "default" not found. Use --force to continue.

Aborted due to warnings.

Upgrade phantom-js dependency

It's no longer possible to get the binary of phantom-js v0.7.2. It should be upgraded to 2.x+ in grunt-docbase project.

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.