forked from
anirudh.fi/vite
fork of anirudh.fi/vite that uses chroma for hl
Rework readme
+47
-5
+47
-5
readme
+47
-5
readme
···
1
1
go-vite
2
2
-------
3
3
4
-
vite, but in Go.
4
+
A fast (this time, actually) and minimal static site generator.
5
5
6
-
Works with vite projects. You will have to rework Jinja2 templates to Go
7
-
templates. Look at my site[1] for an example.
8
6
9
7
INSTALLING
10
8
···
15
13
16
14
Requires `go` to be installed, obviously.
17
15
16
+
18
17
USAGE
19
18
20
19
vite [options]
···
26
25
build builds the current project
27
26
new PATH create a new markdown post
28
27
29
-
NOTES
28
+
29
+
CONFIGURATION
30
+
31
+
vite expects a config.yaml file to exist in the project root. You can
32
+
refer https://git.icyphox.sh/site/tree/config.yaml for an example
33
+
containing all possible keys.
34
+
35
+
36
+
TEMPLATING
37
+
38
+
vite uses Go templating[2], and exposes two structure instances for
39
+
rendering stuff in your template: `Cfg` and `Fm`, defined like so:
40
+
41
+
// Cfg
42
+
struct {
43
+
Title string `yaml:"title"`
44
+
Header string `yaml:"header"`
45
+
DateFmt string `yaml:"datefmt"`
46
+
SiteURL string `yaml:"siteurl"`
47
+
Description string `yaml:"description"`
48
+
Author map[string]string `yaml:"author"`
49
+
Footer string `yaml:"footer"`
50
+
Prebuild []string `yaml:"prebuild"`
51
+
Postbuild []string `yaml:"postbuild"`
52
+
RSSPrefixURL string `yaml:"rssprefixurl"`
53
+
}
54
+
55
+
// Fm
56
+
struct {
57
+
Template string
58
+
URL string
59
+
Title string
60
+
Subtitle string
61
+
Date string
62
+
Body string
63
+
}
64
+
65
+
For an example, refer https://git.icyphox.sh/site/tree/templates
66
+
67
+
68
+
FEEDS
30
69
31
70
vite generates Atom feeds for all documents under the `pages/blog/`
32
-
directory.
71
+
directory. I plan to add generation for arbitrary directories, with
72
+
ability to configure the feed file name (defaults to feed.xml right
73
+
now).
33
74
34
75
[1]: https://github.com/icyphox/site
76
+
[2]: https://golang.org/pkg/html/template/