X-Git-Url: https://plomlompom.com/repos/?p=redo-blog;a=blobdiff_plain;f=README.md;h=f16e442ec81aa1475f58fb2bbff1d5356c3e95ad;hp=12d7372247c8cbd88117be6399e1be9dbffb05e2;hb=4c034ef30bec5f882ef641f06602090aea63408a;hpb=9d8c6181a6880b2c6eaa97d16e68d2fa6755cf9e diff --git a/README.md b/README.md index 12d7372..f16e442 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,10 @@ 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/. +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. 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, @@ -34,8 +37,8 @@ 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 ---------------------------------------------- @@ -108,3 +111,5 @@ The article title is derived in .md files from a first line prefixed with `%`, while all other headings are treated as sub-headings. In .rst files, the title is derived from a heading that must be at the top of the document, and be of an adornment style (such as underlining with `=`) used only once in it. + +Symbolic links in public/ to removed article pages are currently not removed.