diff --git a/doc/Command-line.md b/doc/Command-line.md index 26cb826..15d53c7 100644 --- a/doc/Command-line.md +++ b/doc/Command-line.md @@ -41,7 +41,7 @@ By default hablo will generate a very simple banner for your blog with its name The banner is processed when your blog is generated so it's not relative to the root of your blog, the banner file can totally be outside of your blog structure. ```bash -hablo --banner /my/set/of/banner/turtles.html /path/to/your/blog +hablo --banner /my/set/of/banners/turtles.html /path/to/your/blog ``` ## Card image @@ -154,7 +154,7 @@ The file is read by hablo when the blog is generated and its content gets includ `-R, --rss` -Enables the generation of RSS feeds for each [list](https://git.marvid.fr/Tissevert/hablo/wiki/Architectural%20choices#page-types) of articles. The feed consists in an additional `rss.xml` file placed in the same directory as the `index.html` and `all.html` files generated for. The feeds only include the most recent articles exactly as the «short» versions of each list, which means that they are affected by the use of the [`--preview-articles`](#number-of-articles-previewed) option. When this option is enabled, hablo will also include links to the generated feeds in the list pages. Two [template variables](https://git.marvid.fr/Tissevert/hablo/wiki/Template%20variables#rsslinks) control respectively the content and the title of the link. +Enables the generation of RSS feeds for each [list](https://git.marvid.fr/Tissevert/hablo/wiki/Architectural%20choices#page-types) of articles. The feed consists in an additional `rss.xml` file placed in the same directory as the `index.html` and `all.html` files generated for the general lists. The feeds only include the most recent articles exactly as the «short» versions of each list, which means that they are affected by the use of the [`--preview-articles`](#number-of-articles-previewed) option. When this option is enabled, hablo will also include links to the generated feeds in the list pages. Two [template variables](https://git.marvid.fr/Tissevert/hablo/wiki/Template%20variables#rsslinks) control respectively the content and the title of the link. Note that this feature requires setting your site URL with [`--site-url`](#site-url). @@ -170,7 +170,7 @@ Note that this is purely optional and you don't have to use this option if you d `-w, --wording` -This option makes hablo look for the value of the texts used to [generate the pages](https://git.marvid.fr/Tissevert/hablo/wiki/Architectural choices#customization) in an [arbitrary file](https://git.marvid.fr/Tissevert/hablo/wiki/Template variables). It is useful to translate your blog (all texts are in english by default) or to give it a particular feel. +This option makes hablo look for the value of the texts used to [generate the pages](https://git.marvid.fr/Tissevert/hablo/wiki/Architectural%20choices#customization) in an [arbitrary file](https://git.marvid.fr/Tissevert/hablo/wiki/Template%20variables). It is useful to translate your blog (all texts are in english by default) or to give it a particular feel. ```bash hablo --wording /blogs/translations/fr-ca.conf /path/to/your/blog diff --git a/doc/Metadata.md b/doc/Metadata.md index 8ee66fa..6383faa 100644 --- a/doc/Metadata.md +++ b/doc/Metadata.md @@ -1,6 +1,6 @@ # Metadata -Markdown articles are rendered as late as possible into HTML, even the [article pages](https://git.marvid.fr/Tissevert/hablo/wiki/Architectural choices#article-pages) only wrap the markdown content into a `
` element. But metadata are still read by hablo when it analyses your blog because some metadata trigger special behaviors. +Markdown articles are rendered as late as possible into HTML, even the [article pages](https://git.marvid.fr/Tissevert/hablo/wiki/Architectural%20choices#article-pages) only wrap the markdown content into a `` element. But metadata are still read by hablo when it analyses your blog because some metadata trigger special behaviors. ## Format diff --git a/doc/Template-variables.md b/doc/Template-variables.md index 9873bec..51b53da 100644 --- a/doc/Template-variables.md +++ b/doc/Template-variables.md @@ -8,7 +8,7 @@ All template variables are checked at «[compile-time](https://git.marvid.fr/Tis ## Conditional blocks -Now some contexts may vary a bit and sometimes «lack» a variable so some templates like `metadata` need a way to «catch» those possible null values and keep templating. You could for instance decide that most articles of your blog aren't signed because they obviously come from you or the organization that publishes the blog but that when the blog features an article by a special guest it needs a special mention and you would put the corresponding part using the `${author}` variable in a conditional block. The syntax to do so and «warn» the templating system of possible null values is to enclose the corresponding optional part inside `${? ?}` like so : +Now some contexts may vary a bit and sometimes «lack» a variable so some templates like `metadata` need a way to «catch» those possible null values and keep templating. You could for instance decide that most articles of your blog aren't signed because they obviously come from you or the organization that publishes the blog but that when the blog features an article by a special guest it needs a special mention and you would put the corresponding part using the `${author}` variable in a conditional block. The syntax to do so and «warn» the templating system of possible null values is to enclose the corresponding optional part inside `{? ?}` like so : ``` allPage = The articles{? about ${tag}?}