X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=README.md;h=0165c1118adef11d700c960f41f406ca9306f89a;hb=576cff5e1afc893dbc4004a958b66b326b847693;hp=49ad8b182217cb3dcf988d7218871b18144d09f8;hpb=ed5ca83e98679f5f3ce50392320b427a4ac11e02;p=redo-blog
diff --git a/README.md b/README.md
index 49ad8b1..0165c11 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,9 @@ 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 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 +36,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
----------------------------------------------
@@ -55,9 +57,13 @@ called `blog`:
git checkout -f
cd "\$GIT_WORK_TREE"
redo
- git add metadata/author metadata/url metadata/title metadata/*.tmpl metadata/*.automatic_metadata metadata/automatic_metadata
+ git add metadata/author metadata/url metadata/title metadata/*.tmpl metadata/automatic_metadata
+ count=\$(ls -1 metadata/*.automatic_metadata 2>/dev/null | wc -l)
+ if [ "\$count" != 0 ]; then
+ git add metadata/*.automatic_metadata
+ fi
status=\$(git status -s)
- n_updates=\$(printf "$status" | grep -vE '^\?\?' | wc -l)
+ n_updates=\$(printf "\$status" | grep -vE '^\?\?' | wc -l)
if [ "\$n_updates" -gt 0 ]; then
git commit -a -m 'Update metadata'
fi
@@ -103,5 +109,6 @@ break things.
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 `=`) that must be used only once in
-it.
+adornment style (such as underlining with `=`) used only once in it.
+
+Symbolic links in public/ to removed article pages are currently not removed.