exa/reploy
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

add docs

Browse source
This commit is contained in:
Mirek Kratochvil 2023-10-15 23:22:41 +02:00 committed by Mirek Kratochvil
parent 45a95ef439
commit 32529c8c0f
1 changed files with 26 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -61,14 +61,18 @@ markdown file produces one "main" resulting page at the "mount" location, and
optionally several redirect pages and (additions to) category pages. optionally several redirect pages and (additions to) category pages.
All markdown files have to contain a YAML header that describes where the page All markdown files have to contain a YAML header that describes where the page
should go and adds a few other formatting options. The whole content of the YAML header (together with some other data) is also made accessible to the Mustache templates -- that way you can smuggle custom contents to the HTML rendering machinery. should go and adds a few other formatting options. The whole content of the
YAML header (together with some other data) is also made accessible to the
Mustache templates -- that way you can smuggle custom contents to the HTML
rendering machinery.
#### YAML header format #### YAML header format
##### Required options ##### Required options
- `mount` (string): what should be the canonical URL of the page - `mount` (string): what should be the canonical URL of the page
- `title` (string): the name of the page for display in templates and page links - `name` (string): the name of the page for display in templates and page links
(technically, the `name` is not required UNLESS you
##### Optional ##### Optional
@ -78,12 +82,9 @@ should go and adds a few other formatting options. The whole content of the YAML
search index. search index.
- `toc` (boolean or int, default `3`): if false, no ToC is generated for the - `toc` (boolean or int, default `3`): if false, no ToC is generated for the
page. Otherwise the integer sets the depth of the ToC. page. Otherwise the integer sets the depth of the ToC.
- `timestamp` (string): A description of the "timestamp" for the page, - `order` (integer or string, defaults to `name` and then `mount`): order of
typically the date of the last page modification. For any file, this value is the page in page listings. Negative numbers and zero sort before strings,
also defaulted from `<filename>.timestamp` (e.g., `mypage.md.timestamp`), positive numbers sort after strings.
which simplifies generation of the timestamps by external software (see
`scripts/source-timestamps.sh` for an example of how to do that from `git`
history)
- `tags` (array of strings): list of `/`-separated hierarchical tags - `tags` (array of strings): list of `/`-separated hierarchical tags
("categories") that are assigned to the page. The page will be listed in the ("categories") that are assigned to the page. The page will be listed in the
category listings accordingly. category listings accordingly.
@ -95,9 +96,12 @@ should go and adds a few other formatting options. The whole content of the YAML
```md ```md
--- ---
mount: /about-something mount: /about-something
title: About something name: About something
order: -1
toc: 2 toc: 2
template: special.html template: special.html
tags:
- stuff/special
--- ---
# A page about something! # A page about something!
@ -105,6 +109,19 @@ template: special.html
Lorem ipsum etc., as usual. Lorem ipsum etc., as usual.
``` ```
#### Example `tag-metadata.yml`
```yaml
"":
name: "Root tag"
extra_message_can_be_processed_by_template: "xxxx"
test/attempts:
name: "Testing"
order: -1
```
`name` and `order` work just as with pages.
### Template syntax ### Template syntax
Reploy uses the "simple" vanilla Reploy uses the "simple" vanilla