Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: script to convert HTML manual pages to markdown #4620

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions utils/grass_html2md.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
#!/bin/sh
set -eu

###############################################################################
# Convert recursively all .html files to .md (GitHub flavoured Markdown)
#
# Dependencies:
# pandoc
# wget
#
# Author(s):
# Martin Landa, Markus Neteler
#
# Usage:
# If you have "pandoc" in PATH, execute for HTML file conversion in
# current directory and subdirectories:
# ./utils/grass_html2md.sh
#
# COPYRIGHT: (C) 2024 by the GRASS Development Team
#
# This program is free software under the GNU General Public
# License (>=v2). Read the file COPYING that comes with GRASS
# for details.
#
###############################################################################

# define $TMP if not present
if test -z "${TMP}" ; then
TMP="/tmp"
fi

# TODO: path to LUA file setting to be improved (./utils/pandoc_codeblock.lua)
#wget https://raw.githubusercontent.com/OSGeo/grass/refs/heads/main/utils/pandoc_codeblock.lua -O "${TMP}/pandoc_codeblock.lua"
TMP="utils"

# run recursively: HTML to MD
for f in `find . -name *.html`; do
echo "${f}"
cat "${f}" | sed 's#<div class="code"><pre>#<pre><code>#g' | sed 's#</pre></div>#</code></pre>#g' | pandoc \
--from=html --to=markdown -t gfm --lua-filter "${TMP}/pandoc_codeblock.lua" | \
sed 's+ $++g' | sed 's+\.html)+\.md)+g' > "${f%%.html}.md"
done
8 changes: 8 additions & 0 deletions utils/pandoc_codeblock.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
-- Pandoc Lua filter to handle code blocks
-- Test cases
-- raster/r.sun/r.sun.html

-- Function to convert code blocks to markdown
function CodeBlock (cb)
return pandoc.RawBlock('markdown', '```bash\n' .. cb.text .. '\n```\n')
end
Loading