Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

doxer

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

doxer

Doxer is port of Docco for Dox documentation

  • 0.1.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
3
increased by200%
Maintainers
1
Weekly downloads
 
Created
Source

Doxer

Doxer is a port of, and borrows a bit from, Docco but for Dox documentation. Doxer is not perfect and will contains bugs, use at your own risk.

npm install -g doxer
doxer --title "project name" source.js

Will save doxer.html and doxer.css in docs directory after generating the documentation.

Supported top comments

/*!
 * Project comment
 * ...
 * ... 
 */
 
// Project comment
// ...
// ...

// Project comment

// ...
// ...

Using Doxer inside your code

var doxer = require('doxer');

doxer.process({ files: [], title: 'Title' });

It will return an object with html and style properties. Where html is the html document and style is Doxer stylesheet.

Keywords

FAQs

Package last updated on 30 Jul 2012

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc