From 65ff96bffa8a95e0bdc9f70da6b07785c8714a6d Mon Sep 17 00:00:00 2001 From: adnano Date: Wed, 30 Sep 2020 16:23:37 -0400 Subject: [PATCH] Add link to wiki in README.md --- README.md | 117 +----------------------------------------------------- 1 file changed, 1 insertion(+), 116 deletions(-) diff --git a/README.md b/README.md index d9869af..01ae86c 100644 --- a/README.md +++ b/README.md @@ -22,119 +22,4 @@ go install kiln ``` -To export to HTML, use the `-html` flag. - -To generate Atom feeds, use the `-atom` flag. - -## Directory Structure - -A kiln site is organized in the following way: - -``` -src/ Site source -templates/ Templates - page.gmi Page template - index.gmi Directory index template -dst/ Site destination -dst.html/ Site HTML destination -``` - -Running `kiln` takes the contents in `src`, runs them through the templates in -`templates`, and writes the result to `dst`. - -If the `-html` flag is provided, `kiln` will also export the Gemini content as -HTML and output it to `dst.html`. The generated HTML will look like this: - -```html - - - - -<!-- Page title --> - - -``` - -## Permalinks - -Every page and directory in the site is assigned a permalink. -Permalinks are absolute and point to the destination file. - -Examples: - -``` -file: src/posts/2020-09-22-hello-world.gmi -permalink: /posts/hello-world/ - -directory: src/posts/ -permalink: /posts/ -``` - -Pages and directory index files are written to `{{ .Permalink }}/index.gmi`. - -## Templates - -Templates are located in the `templates` directory. -These are the supported templates: - -- `page.gmi`: The template used for pages -- `index.gmi`: The template used for directory index files -- `atom.xml`: The template used when generating Atom feeds - -### Page templates - -Page templates are provided with the following information: - -- `Title`: The title parsed from the first heading in the file -- `Date`: The date parsed from the filename -- `Permalink`: Permalink to the page -- `Content`: The contents of the page (excluding the title) - -Pages can specify dates in their filenames. kiln will recognize the date and -remove it from the permalink. See [Permalinks](#permalinks) for an example. - -Pages can also specify titles in their content. kiln will parse and remove the -title from the content. Example: - -``` -$ cat src/hello-world.gmi -# Hello, world! - -This is some content. - -$ cat templates/page.gmi -Title: {{ .Title }} -Content: -{{ .Content }} - -$ cat dst/hello-world.gmi -Title: Hello, world! -Content: -This is some content. -``` - -### Directory index templates - -Directory index templates are provided with the following information: - -- `Permalink`: Permalink to the directory -- `Pages`: The pages in this directory -- `Directories`: The subdirectories of this directory - -Directory index templates are written to `index.gmi` in the corresponding directory. - -Example: - -``` -$ ls src/posts/ -src/posts/post-1.gmi -src/posts/post-2.gmi - -$ cat templates/index.gmi -{{ range .Pages }}=> {{ .Permalink }} -{{ end }} - -$ cat dst/posts/index.gmi -=> /posts/post-1.gmi -=> /posts/post-2.gmi -``` +For more information, consult the [wiki](https://man.sr.ht/~adnano/kiln/).