/usr/share/monodoc/web/README.md is in monodoc-http 2.11+git20131009.5b1ef35-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | Webdoc
======
Webdoc is the web container for monodoc. It normally includes:
- a header
- a footer
- a navigation tree
- the monodoc iframe
Structure
---------
Each webdoc instance consists of a skin (theme, chrome) and several plugins.
Plugins are located in the plugins directory. The plugins currently available are:
- iframe: helps size the iframe correctly in your webdoc instance. Recommended unless you want to
use your own code for that
- sidebar: left navigation tree. Again, recommended unless you feel like writign and wiring up your own (good luck!)
- fast search: searches while you type
- full search: returns a page of search results (`search.html`). Can be styled however you like.
Skins are located in the skins directory. Each skin consists of:
- `header.html` (required)
- `footer.html` (required)
- additional css and js (usually placed in the `common-extension.css`/`common-extension.js` file)
- images folder (optional)
How to Use
----------
Making a new instance of webdoc is easy. First, you need to edit web.config to point
to the location of your monodoc source root.
`MonodocRootDir` -> monodoc source root
Next, throw your skin into the skins directory (or use one that's already there).
Edit the `plugins.def` file, uncommenting the plugins you want to use, and setting the location of your skin.
|