Skip to content

Commit

Permalink
Update README.mdown
Browse files Browse the repository at this point in the history
  • Loading branch information
millermedeiros committed Dec 9, 2011
1 parent d456016 commit b1de7bf
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.mdown
Expand Up @@ -6,10 +6,6 @@ document, it will also generate a "TOC" (table of contents) for each file and
links to all the pages on the index page, it also provides a basic search
feature and quick browsing between classes/methods/properties.

For a live example check: [AMD-utis documentation](http://millermedeiros.github.com/amd-utils)
or the [**unofficial** NodeJS api](http://millermedeiros.github.com/mdoc/examples/node_api/doc/)
(uses markdown files from [nodejs repository](https://github.com/joyent/node/tree/master/doc/api) as source)

Reasoning behind it: [inline documentation, why I'm ditching it](http://blog.millermedeiros.com/2011/03/inline-documentation-why-im-ditching-it/).


Expand Down Expand Up @@ -50,6 +46,10 @@ You can install it through [NPM](http://npmjs.org):

## Examples

For a live example check: [AMD-utis documentation](http://millermedeiros.github.com/amd-utils)
or the [**unofficial** NodeJS api](http://millermedeiros.github.com/mdoc/examples/node_api/doc/)
(uses markdown files from [nodejs repository](https://github.com/joyent/node/tree/master/doc/api) as source)

### Command line interface

mdoc -i examples/basic/content -o examples/basic/out
Expand All @@ -72,6 +72,16 @@ Check "examples/advanced" for all the available settings.



## Contributing

There are lots of things to improve, check the [issues page](https://github.com/millermedeiros/mdoc/issues)
for a list of bugs and feature requests.

I probably won't have free time to work on it till next year, any help is welcome.
(it also keeps me more motivated)



## License

Released under the MIT license.
Expand Down

0 comments on commit b1de7bf

Please sign in to comment.