<commit_before>
# JavaScript PDoc parser

An attempt to parse [PDoc](http://pdoc.org/syntax.html) with [node.js](http://nodejs.org)

## How to Install

   npm install ndoc

## Quick start

Go to your project's root directory and run

    ndoc lib
    open file://./doc/index.html

## Usage

    ndoc [options] <path>...

    path PATH                 Source files location

    Options:

      -h, --help                Output usage information
      -o, --output PATH         Resulting file(s) location [doc]
      -e, --extension STRING    Source files extension [js]
      -f, --format <html|js>    Documentation format [html]
      -i, --index PATH          Index file [README.md]
      -l FMT, --link-format FMT String format for link to source file [{file}#L{line}]
                                {url} is substituted with the URL of repository read from manifest file
                                {file} is substituted with the name of the source file
                                {line} is substituted with the line number within the source file
                                E.g. http://github.com/nodeca/ndoc/{file}#L{line}
      --package-json PATH       Package manifest [package.json]
      --package-name NAME       Package name
      --package-version VER     Project version
      --package-title TITLE     Package title
      --view-source-label TXT   Text for "View source" link
      --skin PATH               Custom templates

## Syntax

[Syntax](ndoc/blob/master/syntax.md) is authored after [pdoc](https://github.com/tobie/pdoc), with some additional tags.

## License

[MIT](https://github.com/nodeca/ndoc/blob/master/LICENSE)
<commit_msg>readme updated<commit_after># NDoc - JavaScript documentation generator

NDoc is an inline comment parser and JavaScript documentation generator written in node.js.
This project is inspired by [PDoc](http://pdoc.org/syntax.html). It tries to keep compatibility,
but has some differences:

- NDoc is a CLI tool, not library. It doesn't require additional programming to execute.
- Clarified sections syntax. Section now MUST be separated by empty line from the following comments
- Added options for `deprecated` tag: you can set versions, when tag was deprecated and
  when it will be removed.
- Added new tags: `read-only`, `internal`, `chainable`


## How to Install

We suppose, than you already have `node.js` and `npm` installed.
If not - try [nvm](https://github.com/creationix/nvm). Then install NDoc globally

    npm install -g ndoc


## Usage

    ndoc [options] <path>...

    path PATH                 Source files location

    Options:

      -h, --help                Output usage information
      -o, --output PATH         Resulting file(s) location [doc]
      -e, --extension STRING    Source files extension [js]
      -f, --format <html|js>    Documentation format [html]
      -i, --index PATH          Index file [README.md]
      -l FMT, --link-format FMT String format for link to source file [{file}#L{line}]
                                {url} is substituted with the URL of repository read from manifest file
                                {file} is substituted with the name of the source file
                                {line} is substituted with the line number within the source file
                                E.g. http://github.com/nodeca/ndoc/{file}#L{line}
      --package-json PATH       Package manifest [package.json]
      --package-name NAME       Package name
      --package-version VER     Project version
      --package-title TITLE     Package title
      --view-source-label TXT   Text for "View source" link
      --skin PATH               Custom templates

NDoc try to use defaults from `package.json` in current folder. That helps to minimize options count when building
documentation for node.js projects. For example, you can just run:

    ndoc ./lib


## Syntax

[NDoc Syntax](syntax.md). It similar to [PDoc](https://github.com/tobie/pdoc) one, with some extentions.


## For developpers

If you like to make patches or develop skins - install NDoc in developper mode:

    git clone [your_fork_url]
    cd ndoc
    npm install --dev

(!) Note, than because of `jison` you should have to use 0.4.x node branch now. That restriction doesn't applies
to usual install.

After installation you can generate prototype documentation for test:

    .bin/ndoc ./tests -o ./tests/doc

Then open `./test/doc/index.html`. There are also some shortcuts in [Makefile](https://github.com/nodeca/ndoc/blob/master/Makefile),
if you make skin changes and need to constantly rebuild samples.


## License

This project is distributed under [MIT](https://github.com/nodeca/ndoc/blob/master/LICENSE) license.

{'fraction_non_alphanumeric': 0.09158206429780034, 'fraction_numerical': 0.00042301184433164127, 'mean_word_length': 2.297768479776848, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1578381', 'n_tokens_mistral': 1319, 'n_tokens_neox': 1249, 'n_words': 516}