diff options
| author | Mathieu Duponchelle <mathieu.duponchelle@opencreed.com> | 2016-10-16 01:53:38 +0200 |
|---|---|---|
| committer | Mathieu Duponchelle <mathieu.duponchelle@opencreed.com> | 2016-10-16 01:53:38 +0200 |
| commit | 20e9f95622d9133205a4b5c67181e2ffcf4c7a27 (patch) | |
| tree | a338b1f6e5674865707df503c06d5d5ccdc119f3 /README | |
| parent | 82c9e5e6d12e9b0e29c6360a9b177a4b1e347803 (diff) | |
Please update your hotdoc, and read the (updated) README, you
should end up with something looking exactly like:
https://gstreamer.freedesktop.org/documentation2/
Diffstat (limited to 'README')
| -rw-r--r-- | README | 14 |
1 files changed, 9 insertions, 5 deletions
@@ -27,22 +27,26 @@ for *stable* automatic formatting. * We *experimentally* use the hotdoc C extension to include functions by name, follow the steps outlined [here](https://github.com/hotdoc/hotdoc_c_extension) -* Optionally install the `hotdoc_syntax_highlighting_extension`: +* We recompile and override hotdoc's default theme, which is a submodule of this project: ``` -pip install hotdoc-syntax-highlighting-extension +git submodule update --init ``` -* Optionally install the `hotdoc_search_extension`: +Follow the instructions outlined in the theme's README.md, you can dispense +with the last step (building the theme): ``` -pip install hotdoc-search-extension +cd hotdoc_bootstrap_theme +sudo dnf install nodejs # On Fedora +npm install && ./node_modules/bower/bin/bower install +cd .. ``` * Build the portal: ``` -hotdoc run +make ``` * And browse it: |