From c732fa92ed666c371627959977f09b9e9545cca3 Mon Sep 17 00:00:00 2001 From: njms Date: Tue, 29 Aug 2023 10:47:15 -0700 Subject: [PATCH] Rename template.html -> template.liquid everywhere --- README.md | 36 +++++++++++++++++++++++------------- src/main.rs | 2 +- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9f2bf7a..b2c846c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # calathea v1.0-beta -calathea is a small program used to generate static wikis. It takes a -directory of cmark plus github flavoured markdown pages with `[[wikilinks]]` and renders them to -HTML. The output is a flat directory of HTML pages where the wikilinks are -converted to relative links. +calathea is a small program used to generate static wikis. It takes a directory +of cmark plus github flavoured markdown pages with `[[wikilinks]]` and renders +them to HTML. The output is a flat directory of HTML pages where the wikilinks +are converted to relative links. -This project is a complete rewrite and backwards-incompatible version of my other project, now known as ccalathea, which was a simpler version of this written in C. +This project is a complete rewrite and backwards-incompatible version of my +other project, now known as ccalathea, which was a simpler version of this +written in C. ## features - Rendering wikilinks @@ -27,11 +29,12 @@ Besides the above, the following variables can be accessed from the global scope - `incoming` - a list of objects in the form of `{ title, permalink, data, id }` that link to this page - `id` - a trimmed, lower-cased version of the current page's title used internally to reference pages -## installation -calathea has only been tested on Linux, but it should run on most unix systems and macOS as is. It may run on Windows as well, but I don't have a Windows machine to try it out. +## installation calathea has only been tested on Linux, but it should run on +most unix systems and macOS as is. It may run on Windows as well, but I don't +have a Windows machine to try it out. -### From source -Installing from source requires Cargo, which you can install by visiting the [Rust website](https://www.rust-lang.org/tools/install) +### From source Installing from source requires Cargo, which you can install by +visiting the [Rust website](https://www.rust-lang.org/tools/install) From there, run: @@ -43,7 +46,10 @@ $ sudo cp target/release/calathea /usr/local/bin $ chmod +x /usr/local/bin/calathea ``` -If you don't have Git and don't want to set it up, you can also go to [the repo on Codeberg](https://codeberg.org/njms/calathea), click on the three dots under the bar listing the number of commits, branches and tags, and download it as an archive. +If you don't have Git and don't want to set it up, you can also go to [the repo +on Codeberg](https://codeberg.org/njms/calathea), click on the three dots under +the bar listing the number of commits, branches and tags, and download it as an +archive. To uninstall, ``` @@ -59,7 +65,7 @@ Usage: calathea [OPTION...] -o, --output=dir Output directory (default: './build') -s, --src=dir Source directory of pages (default: './pages') - -t, --template=file Template file path (default: './template.html') + -t, --template=file Template file path (default: './template.liquid') -?,, -h, --help Give this help list -v, --version Print the version @@ -67,10 +73,14 @@ Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options. ``` -Running calathea builds pages (by default, any filies in `./pages`) to HTML files outputted in the specified output directory (by default, `./build`). To do this, it renders the pages and inserts them into your template file (by default, `./template.html`). +Running calathea builds pages (by default, any filies in `./pages`) to HTML +files outputted in the specified output directory (by default, `./build`). To +do this, it renders the pages and inserts them into your template file (by +default, `./template.liquid`). -You can specify information about the page in the "frontmatter" in YAML-format, like so +You can specify information about the page in the "frontmatter" in YAML-format, +like so ``` --- diff --git a/src/main.rs b/src/main.rs index f9d4e6a..2d90f4a 100644 --- a/src/main.rs +++ b/src/main.rs @@ -34,7 +34,7 @@ Usage: calathea [OPTION...] -o, --output=dir Output directory (default: './build') -s, --src=dir Source directory of pages (default: './pages') - -t, --template=file Template file path (default: './template.html') + -t, --template=file Template file path (default: './template.liquid') -?,, -h, --help Give this help list -v, --version Print the version