zs/README.md

# zs - Zen Static site generator

zs is an extremely minimal static site generator written in Go.

[![Build Status](https://ci.mills.io/api/badges/prologic/zs/status.svg)](https://ci.mills.io/prologic/zs)

Table of Contents:

<!-- toc -->
- [zs - Zen Static site generator](#zs---zen-static-site-generator)
    * [Quick Start](#quick-start)
    * [Features](#features)
    * [Installation](#installation)
    * [Ideology](#ideology)
    * [Configuration](#configuration)
        * [Configuration file](#configuration-file)
    * [Extensions (Markdown)](#extensions-markdown)
    * [Plugins](#plugins)
        * [Include](#include)
        * [RSS](#rss)
    * [Hooks](#hooks)
    * [Command line usage](#command-line-usage)
    * [zs Users](#zs-users)
    * [Frequently Asked Questions](#frequently-asked-questions)
        * [How do I link to other pages?](#how-do-i-link-to-other-pages)
    * [License](#license)

<!-- tocstop -->

## Quick Start

```console
go install go.mills.io/zs@latest
mkdir .zs && cat > .zs/layout.html <<EOF
<html>
  <head>
    <title>{{ title }}</title>
  </head>
  <body>{{ content }}</body>
</html>
EOF
cat > index.md <<EOF
---
title: Hello World
---

# Hello World

Hello World!
EOF
zs serve
```

For a starter template see the [zs-starter-template](https://git.mills.io/prologic/zs-stater-template) which can also be found running live at [zs.mills.io](https://zs.mills.io).

## Features

- Zero configuration (optional configuration file)
- Highly configurable (flags, env vars, configuration file)
- Cross-platform (macOS, Windows, Linux)
- Highly extensible via plugins in any language
- Works well for blogs and generic static websites (landing pages, etc)
- Easy to learn
- Fast!

## Installation

Download the binaries from [go.mills.io/prologic/zs](https://git.mills.io/prologic/zs):

```console
go install go.mills.io/zs@latest
```

Or build from source manually:

```console
git clone https://git.mills.io/prologic/zs
cd zs
make install
```

## Ideology

Keep your texts in markdown, or HTML format right in the main directory
of your blog/site.

Keep all service files (extensions, layout pages, deployment scripts etc)
in the `.zs` subdirectory.

Define variables in the header of the content files using [YAML front matter](https://assemble.io/docs/YAML-front-matter.html):

```markdown
---
title: My web site
keywords: best website, hello, world
---

Markdown text goes after a header *separator*
```

Use placeholders for variables and plugins in your markdown or html
files, e.g. `{{ title }}` or `{{ command arg1 arg2 }}.

Write extensions in any language you like and put them into the `.zs`
sub-directory.

Everything the extensions prints to stdout becomes the value of the
placeholder.

Every variable from the content header will be passed via environment variables like `title` becomes `$ZS_TITLE` and so on. There are some special variables:

- `$ZS` - a path to the `zs` executable
- `$ZS_OUTDIR` - a path to the directory with generated files
- `$ZS_FILE` - a path to the currently processed markdown file
- `$ZS_URL` - a URL for the currently generated page

## Configuration

By default no configuration is required. Variables can be defined at the top of each content page using YAML front-matter as described in [Idealogy](#ideology). As your site gets more complex, you _may_ want to define a site-level configuration file. There are a couple of ways to do this:

- Using command-line flags of `zs` itself, see `zs --help` for configuration options.
- Using environment variables such as `ZS_PRODUCTION=1`. These match the command-line flags above, are uppercase and prefixed with `ZS_`.
- Using `zs -c/--config ...` to pass an explicit configuration file.
- Placing a `.zs/config.yml` configuration file in your `.zs` directory.

### Configuration file

The basic structure of a configuration file looks like:

```yaml
---
title: zs starter template
description: A starter template for the Zen Static (zs) site generator
keywords: zen, static, zs, starter, template, site, website, template, generator, ssg

extensions:
  - typography
  - wikilink
  - fences
  - embed
  - d2
```

## Extensions (Markdown)

`zs` supports content written in Markdown, `index.md` for example and uses the [Goldmark][goldmark] Markdown parser with a number of extensions enabled by default:

- [anchor][anchor] -- Adds anchors (permalinks) next to all headers in a document.
- [d2][d2] -- Adds support for [D2](https://d2lang.com/) diagrams.
- [embed][embed] -- Adds support for rendering embeds from YouTube links.
- [fences][fences] -- Support for pandoc-style fenced divs.
- [highlighting][highlighting] -- Adds support for syntax highlighting of code.
- [wikilink][wikilink] -- Adds support for [[wiki]]-style links to goldmark.

For a full-list of default extensions enabled, see `zs --help` and the `-e/--extensions` flag.

## Plugins

Plugins are just executables in any language that output content. They can be system executables like `data` or custom scripts or programs that you place in `.zs/`. To use a plugins simply reference it in your content like so:

```markdown
Site last updated at {{{ date }}
```

or:

```markdown
Here's a list of support features:

{{ features }}
```

Where `features` is a script defined in `.zs/features`

Plugins can be written in any language you know (Bash, Python, Lua, JavaScript, Go, even Assembler).

Here are some example plugins you might find useful in your site.

### Include

`.zs/include`:

```bash
#!/bin/sh

if [ -f "$1" ]; then
  cat "$1"
else
  echo "error: file not found $1"
fi
```

### RSS

`.zs/rss`:

```bash
#!/bin/sh

for f in ./blog/*.md ; do
	d="$("$ZS" var "$f" date)"
	if [ ! -z $d ] ; then
		timestamp="$(date --date "$d" +%s)"
		url="$("$ZS" var "$f" url)"
		title="$("$ZS" var "$f" title | tr A-Z a-z)"
		desc="$("$ZS" var "$f" description)"
		echo $timestamp \
			"<item>" \
			"<title>$title</title>" \
			"<link>http://zserge.com/$url</link>" \
			"<description>$desc</description>" \
			"<pubDate>$(date --date @$timestamp -R)</pubDate>" \
			"<guid>http://zserge.com/$url</guid>" \
		"</item>"
	fi
done | sort -r -n | cut -d' ' -f2-
```

Looking for more plugins? Check out the [contrib/plugins](https://git.mills.io/prologic/zs/src/branch/main/contrib/plugins) collection!

## Hooks

There are two special plugin names that are executed every time the build
happens:

- `prehook`  -- executed before the build
- `posthook` -- executed after the build

You can use these to customize the build before and after. For example you can use the `posthook` to minify CSS or Javascript files.

`.zs/posthook`:

```bash
#!/bin/sh

minify -o "$ZS_OUTDIR/css/fa.min.css" "$ZS_OUTDIR/css/fa.css"
minify -o "$ZS_OUTDIR/css/site.min.css" "$ZS_OUTDIR/css/site.css"
```

Looking for more hooks? Check out the [contrib/hooks](https://git.mills.io/prologic/zs/src/branch/main/contrib/hooks) collection!

## Command line usage

- `zs build` re-builds your site.
- `zs build <file>` re-builds one file and prints resulting content to stdout.
- `zs watch` rebuilds your site every time you modify any file.
- `zs serve` rebuilds your site and serve it on the network.
- `zs var <filename> [var1 var2...]` prints a list of variables defined in the
header of a given markdown file, or the values of certain variables (even if
it's an empty string).

For full usage see `zs --help`:

```console
$ zs --help
zs is an extremely minimal static site generator written in Go.

  - Keep your texts in markdown, or HTML format right in the main directory of your blog/site.
  - Keep all service files (extensions, layout pages, deployment scripts etc) in the .zs subdirectory.
  - Define variables in the header of the content files using YAML front matter:
  - Use placeholders for variables and plugins in your markdown or html files, e.g. {{ title }} or {{ command arg1 arg2 }}.
  - Write extensions in any language you like and put them into the .zs sub-directory.
  - Everything the extensions prints to stdout becomes the value of the placeholder.

Usage:
  zs [command]

Available Commands:
  build       Builds the whole site or a single file
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  serve       Serves the site and rebuilds automatically
  var         Display variables for the specified file
  watch       Watches for file changes and rebuilds modified files

Flags:
  -c, --config string        config file (default: .zs/config.yml)
  -D, --debug                enable debug logging $($ZS_DEBUG)
  -d, --description string   site description ($ZS_DESCRIPTION)
  -e, --extensions strings   override and enable specific extensions (default [table,linkify,highlighting,fences,footnote,cjk,d2,embed,wikilink,tasklist,definitionlist,anchor,strikethrough,typography])
  -h, --help                 help for zs
  -k, --keywords string      site keywords ($ZS_KEYWORDS)
  -p, --production           enable production mode ($ZS_PRODUCTION)
  -t, --title string         site title ($ZS_TITLE)
  -v, --version              version for zs

Use "zs [command] --help" for more information about a command.
```

## zs Users

Here's a few sites that use `zs` today:

- https://yarn.social -- Landing page of the decentralized microBlogging ecosystem.
- https://salty.im -- Landing page of the e2e encrypted IndieWeb inspired messaging protocol.
- https://zs.mills.io -- zs starter template demo.
- https://prologic.shortcircuit.net.au -- Home page of James Mills / prologic (author of zs)

Want to add your site here? File an issue or submit a pull-request!

## Frequently Asked Questions

### How do I link to other pages?

Easy! Just write a normal HTML link using an `<a href="/other.html">title</a>` tag or a Markdown link using the normal `[title](/other.html)` syntax.

## License

`zs` is licensed under the terms of the [MIT License](/LICENSE) and was originally forked from [zserge/zs](https://github.com/zserge/zs) also licensed under the terms of the [MIT License](/LICENSE.old).

----

[goldmark]: https://github.com/yuin/goldmark
[anchor]: https://github.com/abhinav/goldmark-anchor
[d2]: https://github.com/FurqanSoftware/goldmark-d2
[embed]: https://github.com/13rac1/goldmark-embed
[fences]: https://github.com/stefanfritsch/goldmark-fences
[highlighting]: https://github.com/yuin/goldmark-highlighting
[wikilink]: https://github.com/abhinav/goldmark-wikilink
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			`# zs - Zen Static site generator`
added travis button 2015-04-10 15:11:37 +03:00
added readme 2014-12-06 00:49:42 +03:00			`zs is an extremely minimal static site generator written in Go.`

Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			`[![Build Status](https://ci.mills.io/api/badges/prologic/zs/status.svg)](https://ci.mills.io/prologic/zs)`
added readme 2014-12-06 00:49:42 +03:00
Add an FAQ section (Fixes #12) 2023-03-16 12:07:18 +03:00			`Table of Contents:`

			`<!-- toc -->`
			`- [zs - Zen Static site generator](#zs---zen-static-site-generator)`
			`* [Quick Start](#quick-start)`
			`* [Features](#features)`
			`* [Installation](#installation)`
			`* [Ideology](#ideology)`
Update README 2023-03-26 05:47:07 +03:00			`* [Configuration](#configuration)`
			`* [Configuration file](#configuration-file)`
Fix README and document extensions and configuration file 2023-03-26 06:36:55 +03:00			`* [Extensions (Markdown)](#extensions-markdown)`
			`* [Plugins](#plugins)`
Update README 2023-03-26 05:47:07 +03:00			`* [Include](#include)`
			`* [RSS](#rss)`
Add an FAQ section (Fixes #12) 2023-03-16 12:07:18 +03:00			`* [Hooks](#hooks)`
			`* [Command line usage](#command-line-usage)`
Fix README 2023-03-27 17:29:49 +03:00			`* [zs Users](#zs-users)`
Update README's TOC 2023-03-16 12:08:10 +03:00			`* [Frequently Asked Questions](#frequently-asked-questions)`
			`* [How do I link to other pages?](#how-do-i-link-to-other-pages)`
Add an FAQ section (Fixes #12) 2023-03-16 12:07:18 +03:00			`* [License](#license)`

			`<!-- tocstop -->`

Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			`## Quick Start`

			```console
Fix instructions for Quick Start 2023-03-27 11:26:56 +03:00			`go install go.mills.io/zs@latest`
			`mkdir .zs && cat > .zs/layout.html <<EOF`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			`<html>`
			`<head>`
			`<title>{{ title }}</title>`
			`</head>`
			`<body>{{ content }}</body>`
			`</html>`
			`EOF`
			`cat > index.md <<EOF`
			`---`
			`title: Hello World`
			`---`

			`# Hello World`

			`Hello World!`
			`EOF`
			`zs serve`
			```

Add sites that use zs and a collection of hooks and plugins to contrib 2023-03-27 17:26:11 +03:00			`For a starter template see the [zs-starter-template](https://git.mills.io/prologic/zs-stater-template) which can also be found running live at [zs.mills.io](https://zs.mills.io).`
Update README and reference zs-starter-template 2023-03-18 13:31:34 +03:00
added readme 2014-12-06 00:49:42 +03:00			`## Features`

Update README 2023-03-26 05:47:07 +03:00			`- Zero configuration (optional configuration file)`
			`- Highly configurable (flags, env vars, configuration file)`
			`- Cross-platform (macOS, Windows, Linux)`
			`- Highly extensible via plugins in any language`
			`- Works well for blogs and generic static websites (landing pages, etc)`
			`- Easy to learn`
			`- Fast!`
added readme 2014-12-06 00:49:42 +03:00
			`## Installation`

Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			`Download the binaries from [go.mills.io/prologic/zs](https://git.mills.io/prologic/zs):`

			```console
Fix install instructions 2023-03-30 13:53:22 +03:00			`go install go.mills.io/zs@latest`
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			```
added readme 2014-12-06 00:49:42 +03:00
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			`Or build from source manually:`
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00
			```console
			`git clone https://git.mills.io/prologic/zs`
			`cd zs`
			`make install`
			```
added readme 2014-12-06 00:49:42 +03:00
			`## Ideology`

Forked project 2021-09-18 02:32:14 +03:00			`Keep your texts in markdown, or HTML format right in the main directory`
updated README 2015-09-03 00:21:50 +03:00			`of your blog/site.`
added readme 2014-12-06 00:49:42 +03:00
			`Keep all service files (extensions, layout pages, deployment scripts etc)`
			in the `.zs` subdirectory.

Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			`Define variables in the header of the content files using [YAML front matter](https://assemble.io/docs/YAML-front-matter.html):`
added readme 2014-12-06 00:49:42 +03:00
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			```markdown
			`---`
			`title: My web site`
			`keywords: best website, hello, world`
			`---`
added readme 2014-12-06 00:49:42 +03:00
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			`Markdown text goes after a header separator`
			```
added readme 2014-12-06 00:49:42 +03:00
			`Use placeholders for variables and plugins in your markdown or html`
updated README 2015-09-03 00:21:50 +03:00			files, e.g. `{{ title }}` or `{{ command arg1 arg2 }}.
added readme 2014-12-06 00:49:42 +03:00
			Write extensions in any language you like and put them into the `.zs`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			`sub-directory.`
added readme 2014-12-06 00:49:42 +03:00
			`Everything the extensions prints to stdout becomes the value of the`
			`placeholder.`

updated README 2015-09-03 00:21:50 +03:00			Every variable from the content header will be passed via environment variables like `title` becomes `$ZS_TITLE` and so on. There are some special variables:
added readme 2014-12-06 00:49:42 +03:00
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			- `$ZS` - a path to the `zs` executable
			- `$ZS_OUTDIR` - a path to the directory with generated files
			- `$ZS_FILE` - a path to the currently processed markdown file
			- `$ZS_URL` - a URL for the currently generated page
added readme 2014-12-06 00:49:42 +03:00
Update README 2023-03-26 05:47:07 +03:00			`## Configuration`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00
Update README 2023-03-26 05:47:07 +03:00			`By default no configuration is required. Variables can be defined at the top of each content page using YAML front-matter as described in [Idealogy](#ideology). As your site gets more complex, you _may_ want to define a site-level configuration file. There are a couple of ways to do this:`

			- Using command-line flags of `zs` itself, see `zs --help` for configuration options.
			- Using environment variables such as `ZS_PRODUCTION=1`. These match the command-line flags above, are uppercase and prefixed with `ZS_`.
			- Using `zs -c/--config ...` to pass an explicit configuration file.
			- Placing a `.zs/config.yml` configuration file in your `.zs` directory.

			`### Configuration file`

			`The basic structure of a configuration file looks like:`

			```yaml
Fix README and document extensions and configuration file 2023-03-26 06:36:55 +03:00			`---`
			`title: zs starter template`
			`description: A starter template for the Zen Static (zs) site generator`
			`keywords: zen, static, zs, starter, template, site, website, template, generator, ssg`

			`extensions:`
			`- typography`
			`- wikilink`
			`- fences`
			`- embed`
			`- d2`
			```

			`## Extensions (Markdown)`

			`zs` supports content written in Markdown, `index.md` for example and uses the [Goldmark][goldmark] Markdown parser with a number of extensions enabled by default:

			`- [anchor][anchor] -- Adds anchors (permalinks) next to all headers in a document.`
			`- [d2][d2] -- Adds support for [D2](https://d2lang.com/) diagrams.`
			`- [embed][embed] -- Adds support for rendering embeds from YouTube links.`
			`- [fences][fences] -- Support for pandoc-style fenced divs.`
			`- [highlighting][highlighting] -- Adds support for syntax highlighting of code.`
			`- [wikilink][wikilink] -- Adds support for [[wiki]]-style links to goldmark.`

			For a full-list of default extensions enabled, see `zs --help` and the `-e/--extensions` flag.
Update README 2023-03-26 05:47:07 +03:00
			`## Plugins`

			Plugins are just executables in any language that output content. They can be system executables like `data` or custom scripts or programs that you place in `.zs/`. To use a plugins simply reference it in your content like so:
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00
			```markdown
			`Site last updated at {{{ date }}`
			```

Fix install instructions 2023-03-30 13:53:22 +03:00			`or:`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00
			```markdown
			`Here's a list of support features:`

			`{{ features }}`
			```
added readme 2014-12-06 00:49:42 +03:00
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			Where `features` is a script defined in `.zs/features`

Update README 2023-03-26 05:47:07 +03:00			`Plugins can be written in any language you know (Bash, Python, Lua, JavaScript, Go, even Assembler).`

			`Here are some example plugins you might find useful in your site.`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00
Update README 2023-03-26 05:47:07 +03:00			`### Include`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00
			`.zs/include`:

			```bash
			`#!/bin/sh`

			`if [ -f "$1" ]; then`
			`cat "$1"`
			`else`
			`echo "error: file not found $1"`
			`fi`
			```

Update README 2023-03-26 05:47:07 +03:00			`### RSS`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00
			`.zs/rss`:
updated README 2015-09-03 00:21:50 +03:00
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			```bash
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			`#!/bin/sh`

updated README 2015-09-03 00:21:50 +03:00			`for f in ./blog/*.md ; do`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			`d="$("$ZS" var "$f" date)"`
updated README 2015-09-03 00:21:50 +03:00			`if [ ! -z $d ] ; then`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			`timestamp="$(date --date "$d" +%s)"`
			`url="$("$ZS" var "$f" url)"`
			`title="$("$ZS" var "$f" title \| tr A-Z a-z)"`
			`desc="$("$ZS" var "$f" description)"`
updated README 2015-09-03 00:21:50 +03:00			`echo $timestamp \`
			`"<item>" \`
			`"<title>$title</title>" \`
			`"<link>http://zserge.com/$url</link>" \`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			`"<description>$desc</description>" \`
updated README 2015-09-03 00:21:50 +03:00			`"<pubDate>$(date --date @$timestamp -R)</pubDate>" \`
			`"<guid>http://zserge.com/$url</guid>" \`
			`"</item>"`
			`fi`
			`done \| sort -r -n \| cut -d' ' -f2-`
			```

Add sites that use zs and a collection of hooks and plugins to contrib 2023-03-27 17:26:11 +03:00			`Looking for more plugins? Check out the [contrib/plugins](https://git.mills.io/prologic/zs/src/branch/main/contrib/plugins) collection!`

added readme 2014-12-06 00:49:42 +03:00			`## Hooks`

			`There are two special plugin names that are executed every time the build`
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			`happens:`

			- `prehook` -- executed before the build
			- `posthook` -- executed after the build

			You can use these to customize the build before and after. For example you can use the `posthook` to minify CSS or Javascript files.

			`.zs/posthook`:
added readme 2014-12-06 00:49:42 +03:00
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			```bash
			`#!/bin/sh`
added readme 2014-12-06 00:49:42 +03:00
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			`minify -o "$ZS_OUTDIR/css/fa.min.css" "$ZS_OUTDIR/css/fa.css"`
			`minify -o "$ZS_OUTDIR/css/site.min.css" "$ZS_OUTDIR/css/site.css"`
			```
updated README 2015-09-03 00:21:50 +03:00
Add sites that use zs and a collection of hooks and plugins to contrib 2023-03-27 17:26:11 +03:00			`Looking for more hooks? Check out the [contrib/hooks](https://git.mills.io/prologic/zs/src/branch/main/contrib/hooks) collection!`

Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			`## Command line usage`
added readme 2014-12-06 00:49:42 +03:00
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			- `zs build` re-builds your site.
			- `zs build <file>` re-builds one file and prints resulting content to stdout.
			- `zs watch` rebuilds your site every time you modify any file.
Add better README, docs and examples of using extensions (Fixes #1) 2023-03-12 11:04:55 +03:00			- `zs serve` rebuilds your site and serve it on the network.
Refactor a bunch of stuff adding zs serve, CI/CD workflows, fixing docs and license (#10) Fixes #5 Fixes #8 Fixes #9 Co-authored-by: James Mills <1290234+prologic@users.noreply.github.com> Reviewed-on: https://git.mills.io/prologic/zs/pulls/10 2023-03-12 07:13:53 +03:00			- `zs var <filename> [var1 var2...]` prints a list of variables defined in the
added readme 2014-12-06 00:49:42 +03:00			`header of a given markdown file, or the values of certain variables (even if`
			`it's an empty string).`

Add an FAQ section (Fixes #12) 2023-03-16 12:07:18 +03:00			For full usage see `zs --help`:

			```console
			`$ zs --help`
			`zs is an extremely minimal static site generator written in Go.`

			`- Keep your texts in markdown, or HTML format right in the main directory of your blog/site.`
Fix README and document extensions and configuration file 2023-03-26 06:36:55 +03:00			`- Keep all service files (extensions, layout pages, deployment scripts etc) in the .zs subdirectory.`
Add an FAQ section (Fixes #12) 2023-03-16 12:07:18 +03:00			`- Define variables in the header of the content files using YAML front matter:`
			`- Use placeholders for variables and plugins in your markdown or html files, e.g. {{ title }} or {{ command arg1 arg2 }}.`
Fix README and document extensions and configuration file 2023-03-26 06:36:55 +03:00			`- Write extensions in any language you like and put them into the .zs sub-directory.`
			`- Everything the extensions prints to stdout becomes the value of the placeholder.`
Add an FAQ section (Fixes #12) 2023-03-16 12:07:18 +03:00
			`Usage:`
			`zs [command]`

			`Available Commands:`
			`build Builds the whole site or a single file`
			`completion Generate the autocompletion script for the specified shell`
			`help Help about any command`
			`serve Serves the site and rebuilds automatically`
			`var Display variables for the specified file`
			`watch Watches for file changes and rebuilds modified files`

			`Flags:`
Fix README and document extensions and configuration file 2023-03-26 06:36:55 +03:00			`-c, --config string config file (default: .zs/config.yml)`
			`-D, --debug enable debug logging $($ZS_DEBUG)`
			`-d, --description string site description ($ZS_DESCRIPTION)`
			`-e, --extensions strings override and enable specific extensions (default [table,linkify,highlighting,fences,footnote,cjk,d2,embed,wikilink,tasklist,definitionlist,anchor,strikethrough,typography])`
			`-h, --help help for zs`
			`-k, --keywords string site keywords ($ZS_KEYWORDS)`
			`-p, --production enable production mode ($ZS_PRODUCTION)`
			`-t, --title string site title ($ZS_TITLE)`
			`-v, --version version for zs`
Add an FAQ section (Fixes #12) 2023-03-16 12:07:18 +03:00
			`Use "zs [command] --help" for more information about a command.`
			```

Fix README 2023-03-27 17:29:49 +03:00			`## zs Users`
Add sites that use zs and a collection of hooks and plugins to contrib 2023-03-27 17:26:11 +03:00
			Here's a few sites that use `zs` today:

			`- https://yarn.social -- Landing page of the decentralized microBlogging ecosystem.`
			`- https://salty.im -- Landing page of the e2e encrypted IndieWeb inspired messaging protocol.`
			`- https://zs.mills.io -- zs starter template demo.`
			`- https://prologic.shortcircuit.net.au -- Home page of James Mills / prologic (author of zs)`

			`Want to add your site here? File an issue or submit a pull-request!`

Add an FAQ section (Fixes #12) 2023-03-16 12:07:18 +03:00			`## Frequently Asked Questions`

			`### How do I link to other pages?`

			Easy! Just write a normal HTML link using an `<a href="/other.html">title</a>` tag or a Markdown link using the normal `[title](/other.html)` syntax.

added readme 2014-12-06 00:49:42 +03:00			`## License`

Update README and reference zs-starter-template 2023-03-18 13:31:34 +03:00			`zs` is licensed under the terms of the [MIT License](/LICENSE) and was originally forked from [zserge/zs](https://github.com/zserge/zs) also licensed under the terms of the [MIT License](/LICENSE.old).
Fix README and document extensions and configuration file 2023-03-26 06:36:55 +03:00
			`----`

			`[goldmark]: https://github.com/yuin/goldmark`
			`[anchor]: https://github.com/abhinav/goldmark-anchor`
			`[d2]: https://github.com/FurqanSoftware/goldmark-d2`
			`[embed]: https://github.com/13rac1/goldmark-embed`
			`[fences]: https://github.com/stefanfritsch/goldmark-fences`
			`[highlighting]: https://github.com/yuin/goldmark-highlighting`
Fix README 2023-03-27 17:29:49 +03:00			`[wikilink]: https://github.com/abhinav/goldmark-wikilink`