Git Product home page Git Product logo

docdoc-cli's Introduction

docdoc

is a tool and work principle designed by precious.

It helps people to document their design process.


docdoc-cli

The docdoc command line interface.

Install this globally and you'll have access to the docdoc command anywhere on your system.

Note: The job of the docdoc command is to load and run the version of docdoc you have installed locally to your documentation, irrespective of its version.

This architectur is heavily inspired by the grunt-cli.

Each docdoc documentation has a package.json and a custom Docdocfile.js where plugins are loaded and configured. Also the docdoc-generator code should be part of a documentation. Everything is kept in a folder named _docdoc. This is by convention.

Use the docdoc-cli that should be installed as global module. The cli code looks for the _docdoc folder and than executes the generator.

This architecture avoids version conflicts between generator and plugins, as each documentation may upgrade its generator and plugins whenever needed.

Installation

Not yet.

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.