aboutsummaryrefslogtreecommitdiff
path: root/scripts/gen_help_html.py
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2019-03-27 11:11:52 +0100
committerJustin M. Keyes <justinkz@gmail.com>2019-04-08 03:42:21 +0200
commit27cd1e07ed4117505b29ce4629bf30d2acb1ceca (patch)
tree7c7db781249b7d067db110344c18060a9f1649e9 /scripts/gen_help_html.py
parent943bedfc86abb2c6ac20079c1c3a4baac1bd726e (diff)
downloadrneovim-27cd1e07ed4117505b29ce4629bf30d2acb1ceca.tar.gz
rneovim-27cd1e07ed4117505b29ce4629bf30d2acb1ceca.tar.bz2
rneovim-27cd1e07ed4117505b29ce4629bf30d2acb1ceca.zip
doc [ci skip]
- README.md: Removed waffle.io because that service is shutting down.
Diffstat (limited to 'scripts/gen_help_html.py')
-rw-r--r--scripts/gen_help_html.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/scripts/gen_help_html.py b/scripts/gen_help_html.py
index f3dd19abb6..dbdeb3c162 100644
--- a/scripts/gen_help_html.py
+++ b/scripts/gen_help_html.py
@@ -1,5 +1,10 @@
# Converts Vim/Nvim documentation to HTML.
#
+# USAGE:
+# 1. python3 scripts/gen_help_html.py runtime/doc/ ~/neovim.github.io/t/
+# 3. cd ~/neovim.github.io/ && jekyll serve --host 0.0.0.0
+# 2. Visit http://localhost:4000/t/help.txt.html
+#
# Adapted from https://github.com/c4rlo/vimhelp/
# License: MIT
#