Git Product home page Git Product logo

docgen's Introduction

Docgen

Static documentation generator for typescript, sass/scss & javascript packages.

Documentation & Demonstration

  1. Installation
npm install -g doc-gen
  1. Initialisation Inside the project directory for the project you want to generate documentation run the init command. This will create a docgen.json configuration file.
docgen init
  1. Generating the static site Once you've edited docgen.json you can generate the site and start a local server to preview it.
docgen generate
docgen serve --watch
  1. Command line help
docgen -h
docgen help <command>

Copyright/License

Copyright 2015 Robin Radic - MIT Licensed

docgen's People

Stargazers

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.