diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 1 | ||||
| -rwxr-xr-x | docs/remote-docs.sh | 5 | ||||
| -rw-r--r-- | docs/use-pagetitle.lua | 14 |
3 files changed, 19 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md index 83f5c79a3..a00b8f39c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,6 +26,7 @@ link on that page. | ------------------------------------ | --------------------------- | | docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform | | docs/links-to-html.lua | pandoc filter to do aliases for html files | +| docs/use-pagetitle.lua | pandoc filter to set html document title | ## API Reference diff --git a/docs/remote-docs.sh b/docs/remote-docs.sh index 939c7264c..b1682e9cd 100755 --- a/docs/remote-docs.sh +++ b/docs/remote-docs.sh @@ -80,7 +80,10 @@ function html_fn() { local link=$(sed -e 's?.so man1/\(.*\)?\1?' <$dir/links/${file%.md}) markdown=$dir/$link.md fi - pandoc --ascii --lua-filter=docs/links-to-html.lua -o $TARGET/${file%%.*}.html $markdown + pandoc --ascii --standalone \ + --lua-filter=docs/links-to-html.lua \ + --lua-filter=docs/use-pagetitle.lua \ + -o $TARGET/${file%%.*}.html $markdown } # Run 'podman help' (possibly against a subcommand, e.g. 'podman help image') diff --git a/docs/use-pagetitle.lua b/docs/use-pagetitle.lua new file mode 100644 index 000000000..ebc92641d --- /dev/null +++ b/docs/use-pagetitle.lua @@ -0,0 +1,14 @@ +local List = require("pandoc.List") + +function Meta(m) + -- Use pagetitle instead of title (prevents pandoc inserting a <H1> title) + m.pagetitle = m.title + m.title = nil + + if m.pagetitle ~= nil and m.pagetitle.t == "MetaInlines" then + -- Add suffix to match the Sphinx HTML documentation + List.extend(m.pagetitle, {pandoc.Str" \u{2014} Podman documentation"}) + end + + return m +end |