aboutsummaryrefslogtreecommitdiff
path: root/scripts/gen_help_html.py
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2019-04-08 03:44:00 +0200
committerGitHub <noreply@github.com>2019-04-08 03:44:00 +0200
commit11bf89e3b58be1dd534b4ea49b1988150cf7d4b8 (patch)
treed13bc141aa3ea8b28c38da091d4cf6af1fcbc040 /scripts/gen_help_html.py
parent943bedfc86abb2c6ac20079c1c3a4baac1bd726e (diff)
parentce76dffda46db99f073e4bcc159507024d2bfbe8 (diff)
downloadrneovim-11bf89e3b58be1dd534b4ea49b1988150cf7d4b8.tar.gz
rneovim-11bf89e3b58be1dd534b4ea49b1988150cf7d4b8.tar.bz2
rneovim-11bf89e3b58be1dd534b4ea49b1988150cf7d4b8.zip
Merge #9796 from justinmk/doc
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
#