nixos/plotinus: convert manual chapter to MD

pennae eb2e1b04 0a70ea5e

Changed files
+44 -27
nixos
+17
nixos/modules/programs/plotinus.md
···
+
# Plotinus {#module-program-plotinus}
+
+
*Source:* {file}`modules/programs/plotinus.nix`
+
+
*Upstream documentation:* <https://github.com/p-e-w/plotinus>
+
+
Plotinus is a searchable command palette in every modern GTK application.
+
+
When in a GTK 3 application and Plotinus is enabled, you can press
+
`Ctrl+Shift+P` to open the command palette. The command
+
palette provides a searchable list of of all menu items in the application.
+
+
To enable Plotinus, add the following to your
+
{file}`configuration.nix`:
+
```
+
programs.plotinus.enable = true;
+
```
+2
nixos/modules/programs/plotinus.nix
···
{
meta = {
maintainers = pkgs.plotinus.meta.maintainers;
+
# Don't edit the docbook xml directly, edit the md and generate it:
+
# `pandoc plotinus.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > plotinus.xml`
doc = ./plotinus.xml;
};
+25 -27
nixos/modules/programs/plotinus.xml
···
-
<chapter xmlns="http://docbook.org/ns/docbook"
-
xmlns:xlink="http://www.w3.org/1999/xlink"
-
xmlns:xi="http://www.w3.org/2001/XInclude"
-
version="5.0"
-
xml:id="module-program-plotinus">
-
<title>Plotinus</title>
-
<para>
-
<emphasis>Source:</emphasis>
-
<filename>modules/programs/plotinus.nix</filename>
-
</para>
-
<para>
-
<emphasis>Upstream documentation:</emphasis>
-
<link xlink:href="https://github.com/p-e-w/plotinus"/>
-
</para>
-
<para>
-
Plotinus is a searchable command palette in every modern GTK application.
-
</para>
-
<para>
-
When in a GTK 3 application and Plotinus is enabled, you can press
-
<literal>Ctrl+Shift+P</literal> to open the command palette. The command
-
palette provides a searchable list of of all menu items in the application.
-
</para>
-
<para>
-
To enable Plotinus, add the following to your
-
<filename>configuration.nix</filename>:
-
<programlisting>
+
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-program-plotinus">
+
<title>Plotinus</title>
+
<para>
+
<emphasis>Source:</emphasis>
+
<filename>modules/programs/plotinus.nix</filename>
+
</para>
+
<para>
+
<emphasis>Upstream documentation:</emphasis>
+
<link xlink:href="https://github.com/p-e-w/plotinus" role="uri">https://github.com/p-e-w/plotinus</link>
+
</para>
+
<para>
+
Plotinus is a searchable command palette in every modern GTK
+
application.
+
</para>
+
<para>
+
When in a GTK 3 application and Plotinus is enabled, you can press
+
<literal>Ctrl+Shift+P</literal> to open the command palette. The
+
command palette provides a searchable list of of all menu items in
+
the application.
+
</para>
+
<para>
+
To enable Plotinus, add the following to your
+
<filename>configuration.nix</filename>:
+
</para>
+
<programlisting>
programs.plotinus.enable = true;
</programlisting>
-
</para>
</chapter>