Literate Programming can be Quick and Dirty.

• Added --version
• Persist folder structure in docs dir via --structured (solves #38)
  • Will be very useful on larger projects or for users that have multiple src folders
  • Necessary to doc similarly named files in different folders
• Ability to include styles inline via --inline
  • This could be useful for sharing a specific src file doc w/out the whole docs folder
  • Avoids link path issues when --structured option is used
• Use custom stylesheet via --css fileName.css
  • -c is an alias for --css
• Use custom template via --template fileName.jst
  • -t is an alias for --template

Docco defaults are retained; these are additional features and should not affect the basic (quick-and-dirty) use-case.

This is related to issue #80

I replaced the table layout of the page with a list of sections, and styled them appropriately.

The CSS is designed for low-resolution up media queries. The base set of styles are for the low-res screen and they stack documentation on top of code.

Take a look (on a mobile device maybe?) : http://justindujardin.github.com/docco/

You can generate docs that mirror your directory structure by calling docco dir/. The standard behavior of docco some.file or docco dir/* is preserved, to avoid breaking current users (if you had a dir in the list of sources, 0.3.0 blows up).

This hopefully satisfies #38. Also, it is hopefully a more straightforward way than --structured-output in #45 (Since most of the usage out there seems to be about generating docs along side a src/ or lib/ dir, rather than inside it).

I love docco, and use it on a regular basis for my projects. I really wish it was a little less 'dirty' without being much more complex, so here are some changes to make that a reality. I've tested them pretty thoroughly, and taken care to document what was changed.

Goals

1. Keep docco.coffee as concise as possible.
2. Add flexibility, with testing to verify that it works as intended.
3. Keep the changes easy-to-review and non-controversial.

Reviewing

To make sure that these changes are easy to review, I've updated my gh-pages branch to reflect them, and made it easy to run the test suite.

View the documented source and tests

Most of the relevant changes start here : http://justindujardin.github.com/docco/#section-17

And, of course, the tests: http://justindujardin.github.com/docco/tests.html

Run the tests

 git clone [email protected]:justindujardin/docco.git
 cd docco/
 npm install .
 cake test

Changes

• Install CoffeeScript, Showdown.js, and Commander.js via NPM package dependencies.
• Add public API so that docco can be require'd and used programatically.
• Add options for custom output path, jst template, and css file to use.
• Add simple test runner (borrowed from CoffeeScript), and tests for new (and old) functionality.
• Add a README.md to the resources directory, explaining the templates it contains. (https://github.com/justindujardin/docco/tree/master/resources)
• Add pagelet.jst and pagelet.css to the resources directory, which output inline HTML for use in an existing DOM page.
• Add cmd.coffee for development use (to invoke docco.coffee from the command line.)
• Update binaries and documentation.

Usage Help

By using commander.js for command line option parsing, docco gets automatically generated usage information:

 $ docco

   Usage: docco [options] <file_pattern ...>

   Options:

     -h, --help             output usage information
     -V, --version          output the version number
     -c, --css [file]       use a custom css file
     -o, --output [path]    use a custom output path
     -t, --template [file]  use a custom .jst template

docco now parses block comments in JavaScript code. This allows you to use natural docs style commenting but still generate docco html. Example:

https://gist.github.com/1440633

Fixes #223.

Previously, if two or more files had the same base filename only one would be documented. The others would be overwritten.

This patch replicates the structure of the source tree in the document output tree to allow source files with the same name but different paths.

Environment: OS: ArchLinux Node: v0.6.6 npm: v1.1.0-beta-4

I installed docco through npm. When I tried to run docco test.js, I received the following error:

node.js:201
    throw e; // process.nextTick error, or 'error' event on first tick
Error: write EPIPE
    at errnoException (net.js:632:11)
    at Object.afterWrite [as oncomplete] (net.js:470:18)

Even after installing python-pygments (sudo pacman -S python-pygments), the error is still there.

Only a css file is generated in docs folder.

Does everyone think it's ok to switch to marky-markdown for markdown parsing in some later version of docco?

There are multiple issues with the marked module that don't seem to be getting fixed. Like nested lists not working. I was thinking of trying a PR to marked, but I saw all the old pull requests, and thought nah.

This commit adds support for multi-line comments with the minimal set of changes while still being compatible with most languages. The one obvious exception is single-line /* */ style-comments in C-style languages.

Derived from https://github.com/jashkenas/docco/pull/72

Now, each time the configure function is called config is wiped and extended upon using the default configuration along with that provided by either programmatically or via the CLI.

I'm hoping this should fix #165 and prevent any further related bugs appearing.

I've been trying to get Docco working on Windows 7. I have the latest version of Node.

I tried using the following tutorial: http://bateru.com/news/2012/03/how-to-install-docco-on-windows-7/

Following everything apart from the Paths. I only added the python paths ';C:\python27;C:\Python27\Scripts;' since Node is already available from the command line.

Everything installs but when I try to use docco, I get

Error: ENOENT, no such file or directory 'c:\Users\user\Downloads\docco\docs\docco.css'

Some debugging reveals that these properties on the options object are always undefined, even if the CLI options were passed.

I was about to submit a PR, but someone else already has: https://github.com/jashkenas/docco/pull/422

edit: Nevermind, that PR only updated the .litcoffee file, not the JS file that is actually executed.

This is the lockfile format that comes with npm v7 and npm v8. It is ostensibly compatible with older versions of npm.

When I ran npm install in order to work on #422, this upgrade happened automatically; I decided to submit the change in a separate PR.

As of commander v8, the options are no longer present on commander itself; they are only available through commander.opts().

Without this change, the options template, css and marked are ignored in Docco 0.9+. I discovered this while trying to recompile the annotated sources of Underscore.

@jashkenas Note that I did not yet recompile the docco.js.

Hi there!

Due to this project's (somewhat surprising, given its age) recent popularity on HN, I've become interested in writing yet another clone, this time in awk. Here's the website for what I'm calling DOC AWK:

https://acdw.casa/docawk/

Feel free to include it in your list!

Hey—I want to write a tutorial about extending the Controller class for lil-gui and I remembered this classic lib...

I just changed the marked dep to the oldest version that doesn't have a vulnerability warning and docco is generating docs again. Tried italicizing something, seems like markdown is still working as well. This is on the latest node 16.13.