diff options
| author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
|---|---|---|
| committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
| commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
| tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/Create-and-serve-multiple-Shaarlis-(farm).md | |
| parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
| download | Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip | |
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation.
Documentation source files are written in Markdown, and configured with a single YAML file.
* http://www.mkdocs.org/
* http://www.mkdocs.org/user-guide/configuration/
Ref. #312
* remove pandoc-generated HTML documentation
* move markdown doc to doc/md/,
* mkdocs.yml:
* generate HTML doc in doc/html
* add pages TOC/ordering
* use index.md as index page
* Makefile: remove execute permissions from generated files
* Makefile: rewrite htmlpages GFM to markdown conversion using sed:
awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks
* Add mkdocs.yml to .gitattributes, exclude this file from release archives
* Makefile: rename: htmldoc -> doc_html target
* run make doc: pull latest markdown documentation from wiki
* run make htmlpages: update html documentation
Diffstat (limited to 'doc/md/Create-and-serve-multiple-Shaarlis-(farm).md')
| -rw-r--r-- | doc/md/Create-and-serve-multiple-Shaarlis-(farm).md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md b/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md new file mode 100644 index 00000000..d0d812a3 --- /dev/null +++ b/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md | |||
| @@ -0,0 +1,57 @@ | |||
| 1 | Example bash script (creates multiple shaarli instances and generates an HTML index of them) | ||
| 2 | |||
| 3 | ```bash | ||
| 4 | #!/bin/bash | ||
| 5 | set -o errexit | ||
| 6 | set -o nounset | ||
| 7 | |||
| 8 | #config | ||
| 9 | shaarli_base_dir='/var/www/shaarli' | ||
| 10 | accounts='bob john whatever username' | ||
| 11 | shaarli_repo_url='https://github.com/shaarli/Shaarli' | ||
| 12 | ref="master" | ||
| 13 | |||
| 14 | #clone multiple shaarli instances | ||
| 15 | if [ ! -d "$shaarli_base_dir" ]; then mkdir "$shaarli_base_dir"; fi | ||
| 16 | |||
| 17 | for account in $accounts; do | ||
| 18 | if [ -d "$shaarli_base_dir/$account" ]; | ||
| 19 | then echo "[info] account $account already exists, skipping"; | ||
| 20 | else echo "[info] creating new account $account ..."; git clone --quiet "$shaarli_repo_url" -b "$ref" "$shaarli_base_dir/$account"; fi | ||
| 21 | done | ||
| 22 | |||
| 23 | #generate html index of shaarlis | ||
| 24 | htmlhead='<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> | ||
| 25 | <!-- Minimal html template thanks to http://www.sitepoint.com/a-minimal-html-document/ --> | ||
| 26 | <html lang="en"> | ||
| 27 | <head> | ||
| 28 | <meta http-equiv="content-type" content="text/html; charset=utf-8"> | ||
| 29 | <title>My Shaarli farm</title> | ||
| 30 | <style>body {font-family: "Open Sans"}</style> | ||
| 31 | </head> | ||
| 32 | <body> | ||
| 33 | <div> | ||
| 34 | <h1>My Shaarli farm</h1> | ||
| 35 | <ul style="list-style-type: none;">' | ||
| 36 | |||
| 37 | accountlinks='' | ||
| 38 | |||
| 39 | htmlfooter=' | ||
| 40 | </ul> | ||
| 41 | </div> | ||
| 42 | </body> | ||
| 43 | </html>' | ||
| 44 | |||
| 45 | |||
| 46 | |||
| 47 | for account in $accounts; do accountlinks="$accountlinks\n<li><a href=\"$account\">$account</a></li>"; done | ||
| 48 | if [ -d "$shaarli_base_dir/index.html" ]; then echo "[removing old index.html]"; rm "$shaarli_base_dir/index.html" ]; fi | ||
| 49 | echo "[info] generating new index of shaarlis" | ||
| 50 | echo -e "$htmlhead $accountlinks $htmlfooter" > "$shaarli_base_dir/index.html" | ||
| 51 | echo '[info] done.' | ||
| 52 | echo "[info] list of accounts: $accounts" | ||
| 53 | echo "[info] contents of $shaarli_base_dir:" | ||
| 54 | tree -a -L 1 "$shaarli_base_dir" | ||
| 55 | ``` | ||
| 56 | |||
| 57 | This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like [Ansible](https://www.ansible.com/) \ No newline at end of file | ||