aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Mathes <adam@trenchant.org>2017-02-10 18:48:52 -0800
committerAdam Mathes <adam@trenchant.org>2017-02-10 18:48:52 -0800
commit8a24a321b0690558fe02c7c9ef6c96ddfffc9220 (patch)
tree114dbf5b6424d0789ce1d6c2f6ca9a2cba82d9a4
parent53cac2114e8ebfe6cff97eee1be518857fce18e3 (diff)
downloadsnkt-8a24a321b0690558fe02c7c9ef6c96ddfffc9220.tar.gz
snkt-8a24a321b0690558fe02c7c9ef6c96ddfffc9220.tar.bz2
snkt-8a24a321b0690558fe02c7c9ef6c96ddfffc9220.zip
docs docs docs
-rw-r--r--README.md12
1 files changed, 1 insertions, 11 deletions
diff --git a/README.md b/README.md
index e131c04..e60ca64 100644
--- a/README.md
+++ b/README.md
@@ -178,22 +178,12 @@ Templates use the standard library [Go text/template](https://golang.org/pkg/tex
```go
Title string
URL string
-
Posts post.Posts
-
- // all archives are optional based on presence of template
- Archive *archive.ListArchive
- Home *archive.ListArchive
- Rss *archive.ListArchive
- Paged *archive.PagedArchives
```
#### Post (see post/post.go)
```go
- Raw []byte
- Unparsed string
-
// Metadata
Meta map[string]string
SourceFile string
@@ -276,7 +266,7 @@ Permalink (URLs for individual posts) can be customized. This part is *meh* and
| %F | Filename | foo |
| %T | Title | bar |
-Filenames and titles will be "cleaned" of characters unsuitable for links. Extension will be removed from the Filename.
+`Filename` is a cleaned version of the post's original filename with the extension removed. Filenames and titles will be "cleaned" of characters unsuitable for links, with whitespace replaced by `-`.
### Filters