diff --git a/docs/cli.rst b/docs/cli.rst index d056037..4d4e0ab 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -38,6 +38,15 @@ For all options, do: adoc author-mode --help +Why the output missing styling (CSS stylesheet)? +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +You probably did a :ref:`development-install` without :ref:`web-compiler` +and you are building directly (``make html``) instead of using Author Mode. + +If you don't want to install ``npm``, use Author Mode and accept the prompt to +fetch the pre-built web-scripts from the latest release. + Why is the Python source code of this repo not watched? ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ diff --git a/docs/install.rst b/docs/install.rst index 1db92e5..61e7d21 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -65,11 +65,14 @@ reinstalling. Also extends Author Mode to watch changes on the webpage source code (use `--dev`/`-r` option to enable this). +.. _web-compiler: + Install the web compiler ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you care about the web scripts (`js modules`) and style sheets (`sass`), -install ``npm`` first, if not, just skip this section. +install ``npm`` and the ``npm`` packages below, if not, read this section's +last paragraph. .. note:: @@ -87,6 +90,11 @@ At the repository root, install the `npm` dependencies locally: sass \ --save-dev +If you choose to not use ``npm``, you can obtain pre-built web-scripts from the +latest release. +For that, just run :ref:`author-mode` after the repository is installed and +confirm the prompt that will appear. + Fetch third-party resources ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~