ssg 0.0.38

A Content-First Open Source Static Site Generator (SSG) crafted in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

---

# Front Matter (YAML)

author: "support@polaris.example.com (Polaris)"
banner_alt: "Polaris banner"
banner_height: "398"
banner_width: "1440"
banner: ""
cdn: "https://cloudcdn.pro"
changefreq: "weekly"
charset: "utf-8"
cname: "docs.polaris.example.com"
copyright: "Copyright © 2024-2026 Polaris. All rights reserved."
date: "April 16, 2026"
description: "Configuration reference for Polaris."
download: ""
format-detection: "telephone=no"
hreflang: "en"
icon: ""
id: "https://docs.polaris.example.com"
image_alt: "Polaris logo"
image_height: "630"
image_width: "1200"
image: ""
keywords: "docs, ssg, static site generator, rust, example"
language: "en-GB"
layout: "page"
locale: "en_GB"
logo_alt: "Polaris logo"
logo_height: "33"
logo_width: "100"
logo: ""
name: "Polaris"
permalink: "https://docs.polaris.example.com/configuration/"
rating: "general"
referrer: "no-referrer"
revisit-after: "7 days"
robots: "index, follow"
short_name: "kaishi"
subtitle: "Every configuration option, with defaults and examples."
theme-color: "26, 58, 138"
tags: "docs, ssg, example"
title: "Configuration Reference"
url: "https://docs.polaris.example.com"
viewport: "width=device-width, initial-scale=1, shrink-to-fit=no"

# News - The News SiteMap front matter (YAML).
news_genres: "Blog"
news_keywords: "docs, ssg, example"
news_language: "en"
news_image_loc: ""
news_loc: "https://docs.polaris.example.com"
news_publication_date: "Wed, 16 Apr 2026 00:00:00 GMT"
news_publication_name: "Polaris"
news_title: "Configuration Reference"

# RSS - The RSS feed front matter (YAML).
atom_link: https://docs.polaris.example.com/rss.xml
category: "guides"
schema: "doc"
docs: https://validator.w3.org/feed/docs/rss2.html
generator: "SSG (version 0.0.37)"
item_description: RSS feed for Polaris
item_guid: "https://docs.polaris.example.com/configuration/index.html"
item_link: "https://docs.polaris.example.com/configuration/index.html"
item_pub_date: "Wed, 16 Apr 2026 00:00:00 GMT"
item_title: "Configuration Reference"
last_build_date: "Wed, 16 Apr 2026 00:00:00 GMT"
managing_editor: support@polaris.example.com (Polaris)
pub_date: "Wed, 16 Apr 2026 00:00:00 GMT"
ttl: "60"
type: "website"
webmaster: support@polaris.example.com (Polaris)

# Apple - The Apple front matter (YAML).
apple_mobile_web_app_orientations: "portrait"
apple_touch_icon_sizes: "192x192"
apple-mobile-web-app-capable: "yes"
apple-mobile-web-app-status-bar-inset: "black"
apple-mobile-web-app-status-bar-style: "black-translucent"
apple-mobile-web-app-title: "Polaris"
apple-touch-fullscreen: "yes"

# MS Application - The MS Application front matter (YAML).
msapplication-navbutton-color: "rgb(0,102,204)"

# Twitter Card - The Twitter Card front matter (YAML).
twitter_card: "summary"
twitter_creator: "docs"
twitter_description: "Configuration reference for Polaris."
twitter_image: ""
twitter_image_alt: "Polaris logo"
twitter_site: "docs"
twitter_title: "Configuration Reference"
twitter_url: "https://docs.polaris.example.com"

# Humans.txt - The Humans.txt front matter (YAML).
author_website: "https://docs.polaris.example.com"
author_twitter: "@docs"
author_location: "London, UK"
thanks: "Thanks for reading!"
site_last_updated: "2026-04-16"
site_standards: "HTML5, CSS3, RSS, Atom, JSON, XML, YAML, Markdown, TOML"
site_components: "SSG, Polaris Templates"
site_software: "SSG, Rust"

---

## Configuration file

Polaris reads `~/.config/polaris/config.toml` on start. CLI flags override file values. Env vars override both.

```toml
[auth]
method = "oauth"          # "oauth" | "token" | "iam"
cache_credentials = true

[server]
endpoint = "https://api.polaris.example.com"
timeout_seconds = 30

[output]
format = "table"          # "table" | "json" | "csv"
colour = "auto"           # "auto" | "always" | "never"
```

## Environment variables

| Variable | Default | Purpose |
|----------|---------|---------|
| `POLARIS_TOKEN` | — | Override the cached OAuth token |
| `POLARIS_ENDPOINT` | `https://api.polaris.example.com` | Override the API endpoint |
| `POLARIS_TIMEOUT` | `30` | Per-request timeout in seconds |
| `POLARIS_FORMAT` | `table` | Default output format |
| `POLARIS_NO_COLOUR` | unset | Disable ANSI colour in output |

## CLI flags

Flags accepted by every command:

- `--endpoint <URL>` — override the configured endpoint
- `--format <table|json|csv>` — override the output format
- `--quiet` — suppress informational logging
- `--verbose` — include debug logging on stderr