|
1 | | -:doctitle: --css command-line option |
| 1 | +:doctitle: --css, --css-based-on-bootstrap command-line options |
2 | 2 |
|
3 | | -By default, pasdoc generates a pasdoc.css file in the generated |
4 | | -documentation in link:HtmlOutput[HTML] and link:HtmlHelp[HtmlHelp] |
5 | | -formats. |
| 3 | +## Introduction |
6 | 4 |
|
7 | | -If you want to use your own style sheet, you can use the |
8 | | -link:CommandLine[CommandLine] option --css=CSS-FILE-NAME. Then pasdoc |
9 | | -will simply copy the given file CSS-FILE-NAME to the output directory as |
10 | | -pasdoc.css. |
| 5 | +You can control what your link:HtmlOutput[HTML] and link:HtmlHelp[HtmlHelp] |
| 6 | +documentation looks like by tweaking the CSS file. |
11 | 7 |
|
12 | | -You can find some alternative stylesheets on |
13 | | -link:PasDocCssExamples[PasDocCssExamples]. |
| 8 | +To use your own style sheet, use the link:CommandLine[CommandLine] option: |
| 9 | + |
| 10 | +- `--css=CSS-FILE` to provide a new CSS file (that does _not_ rely on standard Bootstrap CSS classes, so Bootstrap will not be used in the output). |
| 11 | +
|
| 12 | +- `--css-based-on-bootstrap=CSS-FILE` to provide a new CSS file that _does_ rely on standard Bootstrap CSS classes. So Bootstrap will be used in the output. |
| 13 | +
|
| 14 | +## Default CSS |
| 15 | + |
| 16 | +The https://github.com/pasdoc/pasdoc/blob/master/source/component/pasdoc.css[default pasdoc.css is here]. Note that it relies on Bootstrap, so if you tweak it, provide the new version using link:Css[--css-based-on-bootstrap] command-line option. |
| 17 | + |
| 18 | +The old `pasdoc.css` that does not rely on Bootstrap is here: https://github.com/pasdoc/pasdoc/blob/master/source/component/alternative_css/pasdoc-up-to-0.16.0.css[source/component/alternative_css/pasdoc-up-to-0.16.0.css]. You can tweak it, and provide the new version using link:Css[--css] command-line option. |
| 19 | + |
| 20 | +## Alternative CSS |
| 21 | + |
| 22 | +We provide some alternative CSS styles in the https://github.com/pasdoc/pasdoc/tree/master/source/component/alternative_css/[source/component/alternative_css/] directory of the PasDoc repository. |
| 23 | + |
| 24 | +Use them directly as a starting point for your own CSS styles. |
| 25 | + |
| 26 | +Examples: |
| 27 | + |
| 28 | +``` |
| 29 | +pasdoc *.pas -css=source/component/alternative_css/AscanioPressato.css |
| 30 | +
|
| 31 | +pasdoc *.pas -css=source/component/alternative_css/ThomasMueller.css |
| 32 | +
|
| 33 | +pasdoc *.pas -css=source/component/alternative_css/pasdoc-up-to-0.16.0.css |
| 34 | +``` |
0 commit comments