Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/azmelanar/hugo-theme-pixyll.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkshcherban <k.scherban@gmail.com>2017-10-22 14:38:56 +0300
committerkshcherban <k.scherban@gmail.com>2017-10-22 14:38:56 +0300
commit4d54629d445a03d37a2ba2e3712c1e1b99ca720f (patch)
tree3090f92d31fbcc8fa7d4f9d99cad858842557ce2
parentf5f0da95e478705bea24f8bbbf61d41de94a9ed7 (diff)
Fixes for search script documentation
-rw-r--r--README.md9
-rw-r--r--requirements.txt2
2 files changed, 7 insertions, 4 deletions
diff --git a/README.md b/README.md
index 52913b1..b6256ad 100644
--- a/README.md
+++ b/README.md
@@ -43,12 +43,13 @@ To activate search ensure that `[params]` section has line `search_engine = true
Then you need to generate search index:
1. Copy script `create_json.py` to your website root location,
where `config.toml` is located.
-1. Install beautifulsoup4 4.3.2: `pip install beautifulsoup4==4.3.2`
-1. Install html5lib 1.0b8: `pip install html5lib==1.0b8`
-1. Run `python22 create_json.py`
+1. Install python requirements: `pip install -r requirements.txt`
+1. Run `python2 create_json.py`
+
+Script was tested with python 2.7 only.
Index will be placed into `public/tipuesearch_content.json`. Every time you add
-new article you need to regenerate index.
+new article you need to regenerate index with command above.
If you run hugo as a server, please append option `--renderToDisk` othervise hugo
will not pick up files generated by search script.
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..a056a46
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+beautifulsoup4==4.3.2
+html5lib==1.0b8