X-Git-Url: https://plomlompom.com/repos/?p=redo-blog;a=blobdiff_plain;f=README.md;h=88573aa86b98909bb93efa9df4d180c3d727f7f6;hp=f16e442ec81aa1475f58fb2bbff1d5356c3e95ad;hb=HEAD;hpb=c841d869ec1eaa8107bece1385038339aa6cfd3e diff --git a/README.md b/README.md index f16e442..88573aa 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,16 @@ run ./add_dir.sh DIRECTORY. 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. +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/linkable/. 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,