bit-docs/bit-docs-docjs-theme

The old DocumentJS theme.

bit-docs

Loosely based on ideas and lessons learned from DocumentJS, bit-docs is an evolving set of tools that allow you to:

• Write documentation inline or in markdown files.
• Specify your code's behavior precisely with JSDoc and Google Closure Compiler annotations.
• Generate multi-version documentation websites for your code from the inline and markdown documentation.
• Customize the theme and lay out the generated website.

Projects currently using bit-docs

• CanJS
• StealJS
• DoneJS

bit-docs-docjs-theme's Issues

Incorrect page title

On the right is the current page title, note the missing "donejs" in the bit-docs version.

Add npm publish scripts

Add docs

Document the purpose of this package, how it’s used, and all of its APIs.

Account for existing anchor ids when adding pretty anchors

Some other plugin (e.g bit-docs-html-toc) might have added ids to some heading elements already, we need to take those ids into account when creating ids for headings without said attribute (bit-docs-html-toc will ignore some headings based on the outline value)

Make this theme generic

It’s currently being used by the StealJS site so it has a bunch of StealJS-specific things in it.

Generated file warning source path is incorrect

####################################################################
  THIS IS A GENERATED FILE -- ANY CHANGES MADE WILL BE OVERWRITTEN

  INSTEAD CHANGE:
  source: [object Object]
  @page steal
########################################################################