Giter VIP home page Giter VIP logo

drachtio-site's Introduction

drachtio

You can run the drachtio site using npm start. For development you can run gulp which uses nodemon and browser-sync.

Install

$ npm install
$ knex-migrator init --mgpath node_modules/ghost
$ gulp serve

Docs

The documentation for the drachtio website is generated from the folders and markdown files in the docs directory. Each folder is a category, and every file in that folder will be rendered under that category. So simply adding a new folder will add a new section to the docs, and so on.

Config

The docs by default sort folders and files alphabetically. This can be changed by modifying docs.conf.json. Here's an example config file:

{
  "getting-started": [
    "introduction"
  ],
  "api": [
    "srf"
  ]
}

Custom orders can be specified by creating an JSON object with a directory as the key and an array of files in a specified order as the value. In this case the api section in the documentation will render srf.md first.

API

You can generate the API docs by running the docs gulp task:

 $ gulp docs

This takes the lib directory in the drachtio folder (which is cloned from the drachtio-srf git repo) and generates markdown files in docs > api.

drachtio-site's People

Contributors

davehorton avatar ttyelud avatar

Stargazers

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