]> git.r.bdr.sh - rbdr/page/blame_incremental - README.gmi
Remove print
[rbdr/page] / README.gmi
... / ...
CommitLineData
1# page
2
3A static website generator for exactly 1 use case.
4
5"I have a bunch of gemini files that I want to serve as-is, but I also
6want to generate some HTML"
7
8## How to use
9
101. Stand on the directory you want to turn into a page
112. run page
123. your output is in ../<directory_name>_html
13
14So for example:
15
16```
17$ pwd
18/home/rbdr/web/website
19$ page
20$ ls ..
21website/
22website_html/
23```
24
25## Front Matter
26
27You can add some optional front matter. We'll look at the two first lines that
28start with `---`
29
30The format is:
31
32```
33--- title: the title of the page
34--- description: a description
35```
36
37This only works if they are the first lines of the page.
38
39## Local Path Translation
40
41Links that end with `.gmi` will be replaced with `.html` unless they specifically start with `gemini:`
42
43## Layouts
44
45page expects a file called _layout.html in the root. It expects three placeholders:
46
47* {{ content }} the generated HTML from parsing the gemini text files.
48* {{ title }} the frontmatter title or an empty string.
49* {{ description }} the frontmatter description or an empty string.
50
51
52## Hidden folders
53
54Hidden folders are copied as well, we only make an exception for `.git/`, and
55`.gitignore` which are explicitly ignored. This is handy for folders like
56`.well-known`, but could cause unwanted behavior if there's other hidden files
57in the directory.
58
59## What happens to files that aren't gemini?
60
61They're copied as-is.