Skip to content

Commit

Permalink
Info on fetching pre-built web-scripts
Browse files Browse the repository at this point in the history
Adds doc info on how to fetch pre-built web-scripts
(sass->css, js->mjs) instead of having the npm tools to generate
them.

Signed-off-by: Jorge Marques <[email protected]>
  • Loading branch information
gastmaier committed Aug 26, 2024
1 parent c3a5d79 commit 3f5e105
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
9 changes: 9 additions & 0 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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?
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Expand Down
10 changes: 9 additions & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand All @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 3f5e105

Please sign in to comment.