plomlompom.com Git - redo-blog/blob - README.md

   1 redo-blog
   2 =========
   3
   4 small blog system using the redo build system
   5
   6 dependencies
   7 ------------
   8
   9 - redo
  10 - python3
  11 - uuidgen
  12 - html2text
  13 - pandoc
  14
  15 testing
  16 -------
  17
  18 Run ./test.sh.
  19
  20 setup
  21 -----
  22
  23 To set up a directory with symbolic links to the relevant files in ./processor/,
  24 run ./add_dir.sh DIRECTORY.
  25
  26 You can then enter the directory and run redo there. This will generate article
  27 .html files from all .md and .rst files, plus a ./index.html, and a ./feed.xml.
  28 These files will be linked to symbolically in a directory ./public/.
  29
  30 Some metadata files will also be generated below ./metadata/: For each article,
  31 there will be generated a .uuid and a .intermediate file; furthermore, files for
  32 data used in ./feed.xml and ./index.html will be built there and can be edited
  33 to customize the blog – namely the files url, author, uuid, title, index.tmpl,
  34 index_snippet.tmpl, article.tmpl.
  35
  36 bugs
  37 ----
  38
  39 Don't create a index.rst or index.md in the redo-managed directory, that will
  40 break things.