Rename template.html -> template.liquid everywhere
This commit is contained in:
parent
cbebdf128b
commit
c732fa92ed
36
README.md
36
README.md
|
@ -1,11 +1,13 @@
|
||||||
# calathea v1.0-beta
|
# calathea v1.0-beta
|
||||||
|
|
||||||
calathea is a small program used to generate static wikis. It takes a
|
calathea is a small program used to generate static wikis. It takes a directory
|
||||||
directory of cmark plus github flavoured markdown pages with `[[wikilinks]]` and renders them to
|
of cmark plus github flavoured markdown pages with `[[wikilinks]]` and renders
|
||||||
HTML. The output is a flat directory of HTML pages where the wikilinks are
|
them to HTML. The output is a flat directory of HTML pages where the wikilinks
|
||||||
converted to relative links.
|
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
|
## features
|
||||||
- Rendering wikilinks
|
- 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
|
- `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
|
- `id` - a trimmed, lower-cased version of the current page's title used internally to reference pages
|
||||||
|
|
||||||
## installation
|
## installation calathea has only been tested on Linux, but it should run on
|
||||||
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.
|
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
|
### From source Installing from source requires Cargo, which you can install by
|
||||||
Installing from source requires Cargo, which you can install by visiting the [Rust website](https://www.rust-lang.org/tools/install)
|
visiting the [Rust website](https://www.rust-lang.org/tools/install)
|
||||||
|
|
||||||
From there, run:
|
From there, run:
|
||||||
|
|
||||||
|
@ -43,7 +46,10 @@ $ sudo cp target/release/calathea /usr/local/bin
|
||||||
$ chmod +x /usr/local/bin/calathea
|
$ 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,
|
To uninstall,
|
||||||
```
|
```
|
||||||
|
@ -59,7 +65,7 @@ Usage: calathea [OPTION...]
|
||||||
|
|
||||||
-o, --output=dir Output directory (default: './build')
|
-o, --output=dir Output directory (default: './build')
|
||||||
-s, --src=dir Source directory of pages (default: './pages')
|
-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
|
-?,, -h, --help Give this help list
|
||||||
-v, --version Print the version
|
-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.
|
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
|
||||||
|
|
||||||
```
|
```
|
||||||
---
|
---
|
||||||
|
|
|
@ -34,7 +34,7 @@ Usage: calathea [OPTION...]
|
||||||
|
|
||||||
-o, --output=dir Output directory (default: './build')
|
-o, --output=dir Output directory (default: './build')
|
||||||
-s, --src=dir Source directory of pages (default: './pages')
|
-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
|
-?,, -h, --help Give this help list
|
||||||
-v, --version Print the version
|
-v, --version Print the version
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue