diff options
| author | Jérémie Laval <jeremie.laval@gmail.com> | 2012-08-31 23:38:20 +0400 |
|---|---|---|
| committer | Jérémie Laval <jeremie.laval@gmail.com> | 2012-08-31 23:40:34 +0400 |
| commit | a972953d5613810b1533db359103abc0d3daaefa (patch) | |
| tree | cde176f68a00c7440c535111a10510c0b4af21b0 /webdoc | |
| parent | 8f4b7e7558414c594b7d5336e0f3c9da80629e4e (diff) | |
[webdoc] Document configuration options
Diffstat (limited to 'webdoc')
| -rw-r--r-- | webdoc/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/webdoc/README.md b/webdoc/README.md new file mode 100644 index 00000000..20991ea8 --- /dev/null +++ b/webdoc/README.md @@ -0,0 +1,21 @@ +Configuration options +===================== + +Webdoc can be configured with the following variables in the web.config file: + + - `MonodocRootDir`: point where you monodoc source root is + - `GoogleAnalytics`: if you want to register your webdoc instance for analytics, enter your API key in that variable + - `ExternalHeader`/`ExternalFooter`: path to an external asset definition file for custom header/footer, definition of the file given below + +External asset file syntax +-------------------------- + +Three types of ressources can be declared: `html`, `css` and `javascript`. You usually wants at least `html` but none of the fields are mandatory. You declare one resource per line in a key-value pair separated by an equal ('=') sign with the right hand-side being the path to the asset. + +An example of such file follows: + + # Comments begin with a hash + html=external/header.html + css=external/header.css + javascript=external/header.js + |