_____ _ _ _______ ____ _____
| __ \ (_)_(_) |__ __/ __ \ / ____|
| | | | ___ ___ ___ / _ \ _ __ ___ ___ | | | | | | |
| | | |/ _ \ / __/ __| | | | '__/ _ \/ __| | | | | | | |
| |__| | (_) | (_| (__| |_| | | | __/ (__ | | | |__| | |____
|_____/ \___/ \___\___|\___/|_| \___|\___| |_| \____/ \_____|
This is (er, hopefully?...) the same code as previously released as Docco-TOC v0.7.4. and since long lost to the great /dev/null
I renamed it as 'DoccOrec-TOC' v7.0.5 so to express that it may not be the same as the missing 0.7.4 release and to prevent
accidental inclusion by the unwary.
As for the name?...from Wikipedia: An Orek (Örek in Turkic folklore) is an animated corpse brought back to life, by mystical means...
Docco-TOC is a fork of Docco that adds a simple table-of-contents to generated documentation.
DoccOrec-TOC is a resurection of release v0.7.4 of the Docco-TOC project from circa 2015.
Docco is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.
For more information, see the links below that still work and README.md
Recovery repo: https://github.com/the-moog/docco-toc-v0.7.4+
29/2/2024:
All trace of this package at v0.7.4 was removed from all of github, npm and yarn.
- https://github.com/jashkenas/docco/tags (Current repo)
-
http://jashkenas.github.com/docco/(404) https://www.npmjs.com/package/docco-toc/v/0.7.2- https://npms.io/search?q=docco-toc (Further links broken)
- https://yarnpkg.com/search?q=docco (No listing here)
https://get.cdnpkg.com/docco-toc/0.7.4https://get.cdnpkg.com/docco-toc/0.7.4/docco.jshttps://unpkg.com/docco-toc@0.7.4/docco.js
The github page jashkenas.github.com/docco/ points you to to visit jashkenas.github.io?
....which redirects to <ashkenas.com> and is some sort of pointless .js joke page...
_It was not even in the 'black hole' that is the Wayback Machine as it jumps
from 7.0 to 8.1 with the more recent captures incomplete.
But, after a bit of searching it was found here:
https://runkit-packages.com/18.x.x/1709230338381/docco-toc/README
And, as I needed v0.7.4 to build an old project without making
changes, I recovered this from caches of https://npm.runkit.com/docco-toc
NB: This has been recovered for documentation purposes only
and as the LICENSE file of the time indicates I am permittd to,
I have made this available again.
I am sure that there was for a reason for it vanishing, so:
If at all possible I suggest you DO NOT USE!!
Instead maybe find another, more up-to-date package (e.g. v0.9.1)...
Installation (You probably don't want to do this!!):
sudo npm install -g docco-toc
Usage:
docco-toc [options] FILES
Options:
-h, --help output usage information
-V, --version output the version number
-l, --layout [layout] choose a built-in layouts (parallel, linear)
-c, --css [file] use a custom css file
-o, --output [path] use a custom output path
-t, --template [file] use a custom .jst template
-e, --extension [ext] use the given file extension for all inputs
-L, --languages [file] use a custom languages.json
-m, --marked [file] use custom marked options
Metadata
package on npm: https://npmjs.com/package/docco-tocTO