X-Git-Url: https://plomlompom.com/repos/?p=redo-blog;a=blobdiff_plain;f=README.md;h=c247230c0293a192c7ea57d0ef3c0fd259a4bd29;hp=a0071b3473e19ed7f2b6dd54fac3971a7074f7ca;hb=26fed190fe4fbdb96a33cc180297b597c9c1e38b;hpb=13dfbc049a5d1a6a4f5b6f2453b39542779300b0 diff --git a/README.md b/README.md index a0071b3..c247230 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,8 @@ public web content to sit: ln -s ~/blog/public /var/www/html/blog -Client-side, do this (obviously, replace server and username): +Client-side, do this (you obviously need to customize this code; at least +replace the username `user` and the server name `example.org`): cd ~ git init blog @@ -83,8 +84,8 @@ bugs and peculiarities Don't create a index.rst or index.md in the redo-managed directory, that will break things. -The article title is derived in .md files from a first line prefixed with "% ", +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 +adornment style (such as underlining with `=`) that must be used only once in it.