From a972953d5613810b1533db359103abc0d3daaefa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Laval?= Date: Fri, 31 Aug 2012 20:38:20 +0100 Subject: [webdoc] Document configuration options --- webdoc/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 webdoc/README.md (limited to 'webdoc') 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 + -- cgit v1.2.3