home · contact · privacy
084b244e31b6fee3887ed38b44321961556697b3
[redo-blog] / README.md
1 redo-blog
2 =========
3
4 small blog system using the redo build system, with blog article files written
5 in (pandoc) Markdown or ReStructured Text.
6
7 dependencies
8 ------------
9
10 - redo
11 - python3
12 - uuidgen (Debian package: uuid-runtime)
13 - html2text
14 - pandoc
15
16 testing
17 -------
18
19 Run ./test.sh.
20
21 setup
22 -----
23
24 To set up a directory with symbolic links to the relevant files in ./processor/,
25 run ./add_dir.sh DIRECTORY.
26
27 You can then enter the directory and run redo there. This will generate article
28 .html files from all .md and .rst files, plus a ./index.html, and a ./feed.xml.
29 These files will be linked to symbolically in a directory ./public/.
30
31 Some metadata files will also be generated below ./metadata/: For each article,
32 there will be generated a .automatic_metadata (to contain an article's UUID,
33 checksum, and creation/modification dates) and a .intermediate file (to contain
34 pandoc-formatted article content like title and body); furthermore, files for
35 data used in ./feed.xml and ./index.html will, if non-existant, be built there
36 and can be edited to customize the blog – namely the files url, author, title,
37 index.tmpl, index_snippet.tmpl, article.tmpl. A blog-specific UUID and creation
38 date is stored in ./metadata/automatic_metadata
39
40 recipe to remotely manage a redo blog with git
41 ----------------------------------------------
42
43 On your server, install the dependencies listed above. Then set up a repository
44 for your blog files. Let's assume we want it to sit in our home directory and be
45 called `blog`:
46
47     cd ~
48     mkdir blog
49     git init --bare blog.git
50     cat << EOF > blog.git/hooks/post-update
51     #!/bin/sh
52     blog_dir=~/blog
53     export GIT_DIR=\$(pwd)
54     export GIT_WORK_TREE="\$blog_dir"
55     git checkout -f
56     cd "\$GIT_WORK_TREE"
57     redo
58     git add metadata/author metadata/url metadata/title metadata/*.tmpl metadata/automatic_metadata
59     count=\$(ls -1 metadata/*.automatic_metadata 2>/dev/null | wc -l)
60     if [ "\$count" != 0 ]; then
61       git add metadata/*.automatic_metadata
62     fi
63     status=\$(git status -s)
64     n_updates=\$(printf "\$status" | grep -vE '^\?\?' | wc -l)
65     if [ "\$n_updates" -gt 0 ]; then
66       git commit -a -m 'Update metadata'
67     fi
68     EOF
69     chmod a+x blog.git/hooks/post-update
70
71 Enable management of `~/blog` via redo-blog:
72
73     git clone https://github.com/plomlompom/redo-blog/
74     cd redo-blog/
75     ./add_dir.sh ~/blog
76     mkdir ~/blog/public
77
78 Link to the `public` subdirectory from wherever your web server expects your
79 public web content to sit:
80
81     ln -s ~/blog/public /var/www/html/blog
82
83 Client-side, do this (you obviously need to customize this code; at least
84 replace the username `user` and the server name `example.org`):
85
86     cd ~
87     git init blog
88     cd blog
89     git remote add origin ssh://user@example.org:/home/user/blog.git
90     mkdir metadata
91     echo 'https://example.org/blog/' > metadata/url
92     git add metadata/url
93     git commit -m 'set up blog metadata'
94     git push origin master
95
96 If successful, the git hook will furthermore commit some ~/blog/metadata/ files
97 generated by redo, that can be pulled into the client-side local repository:
98
99     git pull origin master
100
101 bugs and peculiarities
102 ----------------------
103
104 Don't create a index.rst or index.md in the redo-managed directory, that will
105 break things.
106
107 The article title is derived in .md files from a first line prefixed with `%`,
108 while all other headings are treated as sub-headings. In .rst files, the title
109 is derived from a heading that must be at the top of the document, and be of an
110 adornment style (such as underlining with `=`) that must be used only once in
111 it.