aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extending.rst
diff options
context:
space:
mode:
authorLibravatarUnit 193 <unit193@unit193.net>2024-04-23 00:37:58 -0400
committerLibravatarUnit 193 <unit193@unit193.net>2024-04-23 00:37:58 -0400
commit9b0e86a8e74768c4fe848fb5ce8d754292db4e3e (patch)
treecfd424be8ecb68357e6e572033f08bc534bf724f /docs/extending.rst
parent393aa58f2c5afd51f92fd9bd4b6dfd0dc90cea41 (diff)
New upstream version 8.3.0.upstream/8.3.0upstream
Diffstat (limited to 'docs/extending.rst')
-rw-r--r--docs/extending.rst79
1 files changed, 42 insertions, 37 deletions
diff --git a/docs/extending.rst b/docs/extending.rst
index eead796..abd76e4 100644
--- a/docs/extending.rst
+++ b/docs/extending.rst
@@ -6,7 +6,7 @@
.. description:
.. author: The Nikola Team
-:Version: 8.2.3
+:Version: 8.3.0
:Author: Roberto Alsina <ralsina@netmanagers.com.ar>
.. class:: alert alert-primary float-md-right
@@ -40,41 +40,46 @@ When you run ``nikola --help`` you will see something like this:
.. code-block:: console
$ nikola help
- Nikola is a tool to create static websites and blogs. For full documentation and more
- information, please visit https://getnikola.com/
-
+ Nikola is a tool to create static websites and blogs.
+ For full documentation and more information, please visit https://getnikola.com/
Available commands:
- nikola auto automatically detect site changes, rebuild
- and optionally refresh a browser
- nikola bootswatch_theme given a swatch name from bootswatch.com and a
- parent theme, creates a custom theme
- nikola build run tasks
- nikola check check links and files in the generated site
- nikola clean clean action / remove targets
- nikola console start an interactive python console with access to
- your site and configuration
- nikola deploy deploy the site
- nikola dumpdb dump dependency DB
- nikola forget clear successful run status from internal DB
- nikola help show help
- nikola ignore ignore task (skip) on subsequent runs
- nikola import_blogger import a blogger dump
- nikola import_feed import a RSS/Atom dump
- nikola import_wordpress import a WordPress dump
- nikola init create a Nikola site in the specified folder
- nikola list list tasks from dodo file
- nikola mincss apply mincss to the generated site
- nikola new_post create a new blog post or site page
- nikola run run tasks
- nikola serve start the test webserver
- nikola strace use strace to list file_deps and targets
- nikola theme manage themes
- nikola version print the Nikola version number
-
- nikola help show help / reference
- nikola help <command> show command usage
- nikola help <task-name> show task usage
+ nikola auto builds and serves a site; automatically detects site changes,
+ rebuilds, and optionally refreshes a browser
+ nikola build run tasks
+ nikola check check links and files in the generated site
+ nikola clean clean action / remove targets
+ nikola console start an interactive Python console with access to your site
+ nikola default_config Print the default Nikola configuration.
+ nikola deploy deploy the site
+ nikola dumpdb dump dependency DB
+ nikola forget clear successful run status from internal DB
+ nikola github_deploy deploy the site to GitHub Pages
+ nikola help show help
+ nikola ignore ignore task (skip) on subsequent runs
+ nikola import_wordpress import a WordPress dump
+ nikola info show info about a task
+ nikola init create a Nikola site in the specified folder
+ nikola list list tasks from dodo file
+ nikola new_page create a new page in the site
+ nikola new_post create a new blog post or site page
+ nikola orphans list all orphans
+ nikola plugin manage plugins
+ nikola reset-dep recompute and save the state of file dependencies
+ without executing actions
+ nikola rst2html compile reStructuredText to HTML files
+ nikola serve start the test webserver
+ nikola status display site status
+ nikola strace use strace to list file_deps and targets
+ nikola subtheme given a swatch name from bootswatch.com or hackerthemes.com
+ and a parent theme, creates a custom theme
+ nikola tabcompletion generate script for tab-completion
+ nikola theme manage themes
+ nikola version print the Nikola version number
+
+ nikola help show help / reference
+ nikola help <command> show command usage
+ nikola help <task-name> show task usage
That will give you a list of all available commands in your version of Nikola.
Each and every one of those is a plugin. Let's look at a typical example:
@@ -621,10 +626,10 @@ Some (hopefully all) markup compilers support shortcodes in these forms:
.. code:: text
{{% raw %}}{{% foo %}}{{% /raw %}} # No arguments
- {{% raw %}{{% foo bar %}}{{% /raw %}} # One argument, containing "bar"
- {{% raw %}{{% foo bar baz=bat %}}{{% /raw %}} # Two arguments, one containing "bar", one called "baz" containing "bat"
+ {{% raw %}}{{% foo bar %}}{{% /raw %}} # One argument, containing "bar"
+ {{% raw %}}{{% foo bar baz=bat %}}{{% /raw %}} # Two arguments, one containing "bar", one called "baz" containing "bat"
- {{% raw %}{{% foo %}}Some text{{% /foo %}}{{% /raw %}} # one argument called "data" containing "Some text"
+ {{% raw %}}{{% foo %}}Some text{{% /foo %}}{{% /raw %}} # one argument called "data" containing "Some text"
So, if you are creating a plugin that generates markup, it may be a good idea
to register it as a shortcode in addition of to restructured text directive or