X-Git-Url: https://plomlompom.com/repos/?p=redo-blog;a=blobdiff_plain;f=README.md;h=c1d9f4b6c751e3d3d92b7864830328fafab0043f;hp=aa70d01cccd47bad4d3934a4ada8bd2378da9803;hb=7fced3bc8411add4f4d3c6b70ab4a6f01e30277a;hpb=a5038d1a208239f63666e6ae40073fe250a4046d diff --git a/README.md b/README.md index aa70d01..c1d9f4b 100644 --- a/README.md +++ b/README.md @@ -28,14 +28,23 @@ You can then enter the directory and run redo there. This will generate article .html files from all .md and .rst files, plus a ./index.html, and a ./feed.xml. These files will be linked to symbolically in a directory ./public/. +If you provide or edit a file suffixed .links to basename of an article file, +these links will be added as article-specific linkbacks to the .html file and +the feed entry. + +Just like the .links files, article-specific files containing captcha data are +created and can be edited in ./captchas/. The first line of such a file is meant +as a captcha, and the second line as its description, which may be inserted via +templating into the article HTML file. + Some metadata files will also be generated below ./metadata/: For each article, there will be generated a .automatic_metadata (to contain an article's UUID, checksum, and creation/modification dates) and a .intermediate file (to contain pandoc-formatted article content like title and body); furthermore, files for data used in ./feed.xml and ./index.html will, if non-existant, be built there and can be edited to customize the blog – namely the files url, author, title, -index.tmpl, index_snippet.tmpl, article.tmpl. A blog-specific UUID and creation -date is stored in ./metadata/automatic_metadata +index.tmpl, index_snippet.tmpl, article.tmpl, linkback.tmpl. A blog-specific +UUID and creation date is stored in ./metadata/automatic_metadata recipe to remotely manage a redo blog with git ----------------------------------------------