Git Product home page Git Product logo

dev-documentation's Introduction

dev-documentation

A documentation-building server. Heavily inspired and partially copied from mattdesl's excellent budo project.

The core smarts are the documentation project, but this makes a workflow - a feedback loop of editing and previewing documentation - smooth and fast.

This will

  • run a server for you
  • automatically open http://localhost:8000/
  • automatically rebuild documentation when your code changes
  • automatically reload the page for you if you have LiveReload installed.

Installation

This packages the documentationjs project, so it is installable with one command. You'll need nodejs installed.

$ npm install -g dev-documentation

Usage

For a single file

$ dev-documentation index.js

Or just run it in a project directory

$ cd my-project/
$ dev-documentation

dev-documentation's People

Contributors

tmcw avatar

Stargazers

Angus H. avatar

Watchers

James Cloos avatar Matt DesLauriers 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.