Merge: introduce nit_env.sh to setup the shell environement

[nit.git] / share / man / nitdoc.md

diff --git a/share/man/nitdoc.md b/share/man/nitdoc.md
index af3d95c..cd5472a 100644 (file)
--- a/share/man/nitdoc.md
+++ b/share/man/nitdoc.md
@@ -1,5 +1,3 @@
-% NITDOC(1)
-
 # NAME
 
 nitdoc - generates HTML pages of API documentation from Nit source files.
@@ -29,84 +27,92 @@ The format of the documentation is a dialect of [markdown] that allows GitHub fe
 
 Code blocks are interpreted as snippets of Nit programs and intended to be used as examples of code.
 When these code snippets are valid, executable and contain at least and `assert` clause, they could be automatically executed and verified.
-See niunit(1) for details.
+See `nitunit(1)` for details.
 
   [markdown]: http://daringfireball.net/projects/markdown
 
 # OPTIONS
 
-`-d`, `--dir`
-:   output directory.
+### `-d`, `--dir`
+Output directory.
 
-    Where the HTML files are generated.
+Where the HTML files are generated.
 
-    By default, the directory is named `doc`.
+By default, the directory is named `doc`.
 
-`--source`
-:   Format to link source code.
+### `--source`
+Format to link source code.
 
-    The format string is used to generated links to some parts of the source-code.
-    Use `%f` for filename, `%l` for first line, and `%L` for last line.
+The format string is used to generated links to some parts of the source-code.
+Use `%f` for filename, `%l` for first line, and `%L` for last line.
 
-    For instance, the [standard library] use the following value to link to files in GitHub:
+For instance, the [standard library] use the following value to link to files in GitHub:
 
-        "https://github.com/privat/nit/blob/$(git rev-parse HEAD)/%f#L%l-%L"
+    "https://github.com/nitlang/nit/blob/$(git rev-parse HEAD)/%f#L%l-%L"
 
-    Here, the `git rev-parse HEAD` is used to link to the current snapshot revision of the file.
+Here, the `git rev-parse HEAD` is used to link to the current snapshot revision of the file.
 
-`--no-attribute`
-:   Ignore the attributes.
+### `--no-attributes`
+Ignore the attributes.
 
-    Note: In Nit, attributes are private. Therefore, this option is only useful
-    when combined with `--private`.
+Note: In Nit, attributes are private. Therefore, this option is only useful
+when combined with `--private`.
 
-`--no-dot`
-:   do not generate graphs with graphviz.
+### `--no-dot`
+Do not generate graphs with graphviz.
 
-`--private`
-:   also generate private API.
+### `--private`
+Also generate private API.
 
 ## CUSTOMIZATION
 
-`--sharedir`
-:   directory containing nitdoc assets.
+### `--sharedir`
+Directory containing nitdoc assets.
 
-    By default `$NIT_DIR/share/nitdoc/` is used.
+By default `$NIT_DIR/share/nitdoc/` is used.
 
-`--shareurl`
-:   use shareurl instead of copy shared files.
+### `--shareurl`
+Use shareurl instead of copy shared files.
 
-    By default, assets from the sharedir a copied into the output directory and refered with a relative path in the generated files.
-    Whith this option, the assets are not copied and the given URL of path is used in the generated files to locate assets.
+By default, assets from the sharedir a copied into the output directory and referred with a relative path in the generated files.
+With this option, the assets are not copied and the given URL of path is used in the generated files to locate assets.
 
-`--custom-title`
-:   custom title for homepage.
+### `--custom-title`
+Custom title for homepage.
 
-`--custom-footer-text`
-:   custom footer text.
+### `--custom-footer-text`
+Custom footer text.
 
-`--custom-overview-text`
-:   custom intro text for homepage
+### `--custom-overview-text`
+Custom intro text for homepage.
 
-`--custom-brand`
-:   custom link to external site
+### `--custom-brand`
+Custom link to external site.
 
 ## SERVICES
 
-`--github-upstream`
-:   Git branch where edited commits will be pulled into (ex: user:repo:branch)
+### `--github-upstream`
+Git branch where edited commits will be pulled into (ex: user:repo:branch).
+
+### `--github-base-sha1`
+Git sha1 of base commit used to create pull request.
+
+### `--github-gitdir`
+Git working directory used to resolve path name (ex: /home/me/myproject/).
+
+### `--piwik-tracker`
+Piwik tracker URL (ex: `nitlanguage.org/piwik/`).
 
-`--github-base-sha1`
-:   Git sha1 of base commit used to create pull request
+### `--piwik-site-id`
+Piwik site ID.
 
-`--github-gitdir`
-:   Git working directory used to resolve path name (ex: /home/me/myproject/)
+## TESTING
 
-`--piwik-tracker`
-:   Piwik tracker URL (ex: `"nitlanguage.org/piwik/"`)
+### `--test`
+Print test data (metrics and structure).
 
-`--piwik-site-id`
-:   Piwik site ID
+### `--no-render`
+Do not render HTML files.
 
 # SEE ALSO