You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When you run ``nikola --help`` you will see something like this::
37
+
When you run ``nikola --help`` you will see something like this:
38
+
39
+
.. code-block:: console
38
40
39
41
$ nikola help
40
42
Nikola is a tool to create static websites and blogs. For full documentation and more
@@ -146,7 +148,9 @@ For your own plugin, just change the values in a sensible way. The
146
148
httpd.serve_forever()
147
149
148
150
As mentioned above, a plugin can have options, which the user can see by doing
149
-
``nikola help command`` and can later use, for example::
151
+
``nikola help command`` and can later use, for example:
152
+
153
+
.. code-block:: console
150
154
151
155
$ nikola help serve
152
156
Purpose: start the test webserver
@@ -258,7 +262,7 @@ T
258
262
and ``TaskMultiplier`` plugins that take a task and create
259
263
more tasks out of it.
260
264
261
-
::
265
+
.. code-block:: console
262
266
263
267
$ nikola list
264
268
Scanning posts....done!
@@ -384,6 +388,18 @@ RestExtension Plugins
384
388
385
389
Implement directives for reStructuredText, see `media.py <https://github.com/getnikola/nikola/blob/master/nikola/plugins/compile/rest/media.py>`__ for a simple example.
386
390
391
+
If your output depends on a config value, you need to make your post record a dependency on a pseudo-path, like this:
392
+
393
+
.. code-block:: text
394
+
395
+
####MAGIC####CONFIG:OPTIONNAME
396
+
397
+
Then, whenever the ``OPTIONNAME`` option is changed in conf.py, the file will be rebuilt.
398
+
399
+
If your directive depends or may depend on the whole timeline (like the post-list directive, where adding new posts
400
+
to the site could make it stale), you should record a dependency on the
0 commit comments