53ed6d7d1e
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
57 lines
1.9 KiB
Markdown
57 lines
1.9 KiB
Markdown
Example bash script (creates multiple shaarli instances and generates an HTML index of them)
|
|
|
|
```bash
|
|
#!/bin/bash
|
|
set -o errexit
|
|
set -o nounset
|
|
|
|
#config
|
|
shaarli_base_dir='/var/www/shaarli'
|
|
accounts='bob john whatever username'
|
|
shaarli_repo_url='https://github.com/shaarli/Shaarli'
|
|
ref="master"
|
|
|
|
#clone multiple shaarli instances
|
|
if [ ! -d "$shaarli_base_dir" ]; then mkdir "$shaarli_base_dir"; fi
|
|
|
|
for account in $accounts; do
|
|
if [ -d "$shaarli_base_dir/$account" ];
|
|
then echo "[info] account $account already exists, skipping";
|
|
else echo "[info] creating new account $account ..."; git clone --quiet "$shaarli_repo_url" -b "$ref" "$shaarli_base_dir/$account"; fi
|
|
done
|
|
|
|
#generate html index of shaarlis
|
|
htmlhead='<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<!-- Minimal html template thanks to http://www.sitepoint.com/a-minimal-html-document/ -->
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8">
|
|
<title>My Shaarli farm</title>
|
|
<style>body {font-family: "Open Sans"}</style>
|
|
</head>
|
|
<body>
|
|
<div>
|
|
<h1>My Shaarli farm</h1>
|
|
<ul style="list-style-type: none;">'
|
|
|
|
accountlinks=''
|
|
|
|
htmlfooter='
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>'
|
|
|
|
|
|
|
|
for account in $accounts; do accountlinks="$accountlinks\n<li><a href=\"$account\">$account</a></li>"; done
|
|
if [ -d "$shaarli_base_dir/index.html" ]; then echo "[removing old index.html]"; rm "$shaarli_base_dir/index.html" ]; fi
|
|
echo "[info] generating new index of shaarlis"
|
|
echo -e "$htmlhead $accountlinks $htmlfooter" > "$shaarli_base_dir/index.html"
|
|
echo '[info] done.'
|
|
echo "[info] list of accounts: $accounts"
|
|
echo "[info] contents of $shaarli_base_dir:"
|
|
tree -a -L 1 "$shaarli_base_dir"
|
|
```
|
|
|
|
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/) |