https://github.com/cdaringe/jsdock

zero configuration API docs published to github pages
https://github.com/cdaringe/jsdock

jsdoc

Last synced: 4 months ago
JSON representation

zero configuration API docs published to github pages

• Host: GitHub
• URL: https://github.com/cdaringe/jsdock
• Owner: cdaringe
• Created: 2017-09-22T06:16:56.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-21T13:42:43.000Z (almost 2 years ago)
• Last Synced: 2025-11-15T05:26:36.936Z (7 months ago)
• Topics: jsdoc
• Language: JavaScript
• Homepage: https://cdaringe.github.io/jsdock/
• Size: 946 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 35
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# jsdock

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [ ![Codeship Status for cdaringe/jsdock](https://app.codeship.com/projects/269e2760-8195-0135-24b6-4e7f91221a42/status?branch=master)](https://app.codeship.com/projects/246951)

## what

a zero configuration tool for well-styled API docs and publishing to gh-pages. just write [JSDoc](https://www.npmjs.com/package/jsdoc) and let `jsdock` do the rest.

## why

there are some good patterns for publishing library API docs that `jsdoc` doesn't

give you right out of the box.  **`jsdock`** is for library authors who want

no brainer API docs without managing boilerplate.

- you want your `README.md` embedded in your API documentation homepage

- you want markdown support in your JSDoc tags. syntax highlighting in examples, etc.

- the default `JSDoc` theme isn't great. [minami](https://github.com/Nijikokun/minami) is 'mo betta

- you (may) want a single command to build and publish your docs to github pages

## install

`npm install --save-dev jsdock`

## example

- you write a library with JSDoc

- you run `jsdock build` and `jsdock publish`

```json5

// package.json

{

  "scripts": {

    "docs:build": jsdock build, // builds to docs/ dir in project root

    "docs:publish": jsdoc publish, // publish to .github.io/

    "docs:clean": jsdock clean

  }

}

```

currently you must:

- have a README.md

- put your source in `src/`.

  - if you don't like that ^, send me a PR

- use node 7.10.+

## api/demo

see the [api docs](https://cdaringe.github.io/jsdock).

## really?

yes. configuration sucks.  checking it in is totally 2016.

sorry for the confusing name. ;)