Mercurial > yakumo_izuru > aya

comparison README.md @ 47:0adadd497d23 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Forked project
author prologic
date Fri, 17 Sep 2021 23:32:14 +0000
parents ea1bcd29a195
children c6785950280e
comparison
equal deleted inserted replaced
46:afb3280aaf28 47:0adadd497d23
1 zs 1 # zs
2 ==
3
4 [![Build Status](https://travis-ci.org/zserge/zs.svg?branch=master)](https://travis-ci.org/zserge/zs)
5 2
6 zs is an extremely minimal static site generator written in Go. 3 zs is an extremely minimal static site generator written in Go.
7 4
8 It's inspired by `zas` generator, but is even more minimal. 5 It's inspired by `zas` generator, but is even more minimal.
9 6
20 17
21 ## Installation 18 ## Installation
22 19
23 Download the binaries from Github or build it manually: 20 Download the binaries from Github or build it manually:
24 21
25 $ go get github.com/zserge/zs 22 $ go get git.mills.io/prologic/zs
26 23
27 ## Ideology 24 ## Ideology
28 25
29 Keep your texts in markdown, [amber] or HTML format right in the main directory 26 Keep your texts in markdown, or HTML format right in the main directory
30 of your blog/site. 27 of your blog/site.
31 28
32 Keep all service files (extensions, layout pages, deployment scripts etc) 29 Keep all service files (extensions, layout pages, deployment scripts etc)
33 in the `.zs` subdirectory. 30 in the `.zs` subdirectory.
34 31
90 87
91 #!/bin/sh 88 #!/bin/sh
92 lessc < $ZS_OUTDIR/styles.less > $ZS_OUTDIR/styles.css 89 lessc < $ZS_OUTDIR/styles.less > $ZS_OUTDIR/styles.css
93 rm -f $ZS_OUTDIR/styles.css 90 rm -f $ZS_OUTDIR/styles.css
94 91
95 ## Syntax sugar
96
97 By default, `zs` converts each `.amber` file into `.html`, so you can use lightweight Jade-like syntax instead of bloated HTML.
98
99 Also, `zs` converts `.gcss` into `.css`, so you don't really need LESS or SASS. More about GCSS can be found [here][gcss].
100
101 ## Command line usage 92 ## Command line usage
102 93
103 `zs build` re-builds your site. 94 `zs build` re-builds your site.
104 95
105 `zs build <file>` re-builds one file and prints resulting content to stdout. 96 `zs build <file>` re-builds one file and prints resulting content to stdout.
111 it's an empty string). 102 it's an empty string).
112 103
113 ## License 104 ## License
114 105
115 The software is distributed under the MIT license. 106 The software is distributed under the MIT license.
116
117 [amber]: https://github.com/eknkc/amber/
118 [YAML]: https://github.com/go-yaml/yaml
119 [gcss]: https://github.com/yosssi/gcss