diff options
| author | Jan Tojnar <jtojnar@gmail.com> | 2021-07-12 15:54:14 +0200 |
|---|---|---|
| committer | Jan Tojnar <jtojnar@gmail.com> | 2021-07-13 02:10:57 +0200 |
| commit | c9139dfa1a001e32baa6fea9c9373d80c83e39e9 (patch) | |
| tree | a55bbcb0aa06d5568f4682533846d9a23d48e46f /nixos/doc | |
| parent | df55fbb62aea05fa3e48c4f7c2021bba49485ed5 (diff) | |
| download | nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar.gz nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar.bz2 nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar.lz nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar.xz nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar.zst nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.zip | |
doc: Add support for MyST roles
Officially, only the manpage role is supported at the moment.
Unlike in rST, the syntax uses braces instead of colons:
{manpage}`nix.conf(5)`
Diffstat (limited to 'nixos/doc')
| -rwxr-xr-x | nixos/doc/manual/md-to-db.sh | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/nixos/doc/manual/md-to-db.sh b/nixos/doc/manual/md-to-db.sh index dee92fc57fa..e5a1919baa2 100755 --- a/nixos/doc/manual/md-to-db.sh +++ b/nixos/doc/manual/md-to-db.sh @@ -12,7 +12,12 @@ pushd $DIR # TODO: Remove raw-attribute when we can get rid of DocBook altogether. pandoc_commonmark_enabled_extensions=+attributes+fenced_divs+footnotes+bracketed_spans+definition_lists+pipe_tables+raw_attribute pandoc_flags=( - # media extraction and diagram-generator.lua not needed + # Not needed: + # - diagram-generator.lua (we do not support that in NixOS manual to limit dependencies) + # - media extraction (was only required for diagram generator) + # - docbook-reader/citerefentry-to-rst-role.lua (only relevant for DocBook → MarkDown/rST/MyST) + "--lua-filter=$DIR/../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua" + "--lua-filter=$DIR/../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua" "--lua-filter=$DIR/../../../doc/build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua" -f "commonmark${pandoc_commonmark_enabled_extensions}+smart" -t docbook |