https://github.com/webpro/doxstrap

Yet another documentation generator
https://github.com/webpro/doxstrap

Last synced: 4 months ago
JSON representation

Yet another documentation generator

• Host: GitHub
• URL: https://github.com/webpro/doxstrap
• Owner: webpro
• Created: 2014-03-23T12:49:49.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2019-03-13T20:24:24.000Z (about 7 years ago)
• Last Synced: 2025-03-08T19:05:15.507Z (about 1 year ago)
• Language: HTML
• Size: 47.9 KB
• Stars: 4
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# DoxStrap

JavaScript documentation generator based on JSDoc syntax, Dox parser, Twitter Bootstrap CSS, and Prism syntax highlighter.

## Installation

    npm install -g doxstrap

## Usage

Parse the JSDoc in all source files in `src/**/*.js`, and write the output to the `doc` folder:

    doxstrap --title "My Docs" --output doc

## Local

You can also install it local to your project:

    npm install doxstrap --save-dev

    ./node_modules/doxstrap/bin/doxstrap.js --title "My Docs" --output doc