Shape the site
The starter
statac new writes these files into a new site, and every one is yours to change. What is said of each is what its own opening line says, where it has one.
The site’s folder
| File | What it is | Described in |
|---|---|---|
.gitignore |
The folders git leaves out of the site’s history: the built site, and what Statac keeps between builds. | |
statac.yaml |
The site’s settings, written from your answers. | /settings/ |
assets/
| File | What it is | Described in |
|---|---|---|
site.css |
The site’s one stylesheet, linked from templates/base.html. |
/assets/ |
content/
| File | What it is | Described in |
|---|---|---|
404.md |
The page a reader is shown where nothing is published. | /feeds/ |
index.md |
The home page, where you say what the site is. | /new/ |
robots.md |
What crawlers may read, published once the site has an address. | /feeds/ |
sitemap.md |
The sitemap, published once the site has an address. | /feeds/ |
content/notes/
| File | What it is | Described in |
|---|---|---|
index.md |
The notes’ own page, which lists them; every page in this folder is a note, and needs no title. | /lists/ |
note-1.md |
A sample note. | |
note-2.md |
A sample note. | |
note-3.md |
A sample note. |
content/photos/
| File | What it is | Described in |
|---|---|---|
index.md |
The photographs’ own page, which shows them in a grid, 30 to a page so each row of three is full; every page in this folder is one photograph. | /lists/ |
photo-1/index.md |
A sample photograph’s page. | |
photo-1/photo-1.jpg |
A sample picture. | |
photo-1/photo-1.jpg.yaml |
What a reader who can’t see the picture is told in its place. | /pictures/ |
photo-2/index.md |
A sample photograph’s page. | |
photo-2/photo-2.jpg |
A sample picture. | |
photo-2/photo-2.jpg.yaml |
What a reader who can’t see the picture is told in its place. | /pictures/ |
photo-3/index.md |
A sample photograph’s page. | |
photo-3/photo-3.jpg |
A sample picture. | |
photo-3/photo-3.jpg.yaml |
What a reader who can’t see the picture is told in its place. | /pictures/ |
photo-4/index.md |
A sample photograph’s page. | |
photo-4/photo-4.jpg |
A sample picture. | |
photo-4/photo-4.jpg.yaml |
What a reader who can’t see the picture is told in its place. | /pictures/ |
photo-5/index.md |
A sample photograph’s page. | |
photo-5/photo-5.jpg |
A sample picture. | |
photo-5/photo-5.jpg.yaml |
What a reader who can’t see the picture is told in its place. | /pictures/ |
photo-6/index.md |
A sample photograph’s page. | |
photo-6/photo-6.jpg |
A sample picture. | |
photo-6/photo-6.jpg.yaml |
What a reader who can’t see the picture is told in its place. | /pictures/ |
content/posts/
| File | What it is | Described in |
|---|---|---|
first-post/index.md |
The site’s first post, which says how to write the next. | |
first-post/photo-1.jpg |
A sample picture. | |
first-post/photo-1.jpg.yaml |
What a reader who can’t see photo-1.jpg is told in its place. |
/pictures/ |
index.md |
The posts’ own page, which lists them; every page in this folder is a post. | /lists/ |
what-a-post-can-hold/example.css |
A file the sample post shows as code. | |
what-a-post-can-hold/index.md |
A sample post showing each thing a page’s writing can hold, with the way it is written. | /writing/ |
what-a-post-can-hold/photo-2.jpg |
A sample picture. | |
what-a-post-can-hold/photo-2.jpg.yaml |
What a reader who can’t see photo-2.jpg is told in its place. |
/pictures/ |
what-a-post-can-hold/photo-3.jpg |
A sample picture. | |
what-a-post-can-hold/photo-3.jpg.yaml |
What a reader who can’t see the picture is told in its place. | /pictures/ |
what-a-post-can-hold/photo-4.jpg |
A sample picture. | |
what-a-post-can-hold/photo-4.jpg.yaml |
What a reader who can’t see the picture is told in its place. | /pictures/ |
what-a-post-can-hold/photo-5.jpg |
A sample picture. | |
what-a-post-can-hold/photo-5.jpg.yaml |
What a reader who can’t see the picture is told in its place. | /pictures/ |
what-a-post-can-hold/recording-1.m4a |
A sample recording, two seconds long. | |
what-a-post-can-hold/video-1.mp4 |
A sample video, two seconds long. |
data/
| File | What it is | Described in |
|---|---|---|
words.yaml |
The words the templates and snippets show readers, for each language. | /new/ |
snippets/
| File | What it is | Described in |
|---|---|---|
audio.html |
A recording kept in the site, with its caption where it has one. Takes clip. Called as @audio("recording-1.m4a"). |
/videos/ |
beside.html |
The pages either side of this one, each by what it is called. | /lists/ |
called.html |
What a page is called: its name, or for one that goes without a title, as a note may, its date and time. Takes post. |
/lists/ |
entry.html |
A post in a list: its day, its title, its picture where asked, and its opening. Takes post. |
/lists/ |
figure.html |
A picture with its caption. Takes photo, alt. Called as @figure("photo-1.jpg"). |
/pictures/ |
file.html |
A file beside the writing shown as code. Takes name. Called as @file("example.css"). |
/videos/ |
filed.html |
What a page is filed under, its series and its tags. | /lists/ |
gallery.html |
Several pictures, each linked to its largest copy. Takes any number of photos. Called as @gallery("photo-1.jpg", "photo-2.jpg"). |
/pictures/ |
line.html |
A post as one line of a list: its date, its title and a line about it. Takes post. |
/lists/ |
markdown/callout.html |
A callout, written in Markdown as > [!NOTE], with its kind named in words. |
/writing/ |
markdown/image.html |
A picture written in Markdown, as its copies where it is a photograph. | /snippets/ |
mentions.html |
What other sites said of the page, fetched by statac refresh, each marked up as microformats. |
/webmentions/ |
note.html |
A note set apart from the writing around it. Called as @note() and ended with @end. |
/snippets/ |
pager.html |
The way to a list’s pages before and after this one. | /lists/ |
picture.html |
A picture, as its copies where it is a photograph, for the other snippets. Takes photo. |
/pictures/ |
quote.html |
A quotation with who said it (by) and where it was said (cite). Takes by. Called as @quote("Name", cite="Work") and ended with @end. |
/snippets/ |
short.html |
A note in a list: its title where it has one, its writing whole, then its date and its tags. Takes post. |
/lists/ |
thumb.html |
A photograph in a grid: its picture, cut square, as a link to its page. Takes post. |
/pictures/ |
video.html |
A video kept in the site, with its caption where it has one. Takes clip. Called as @video("video-1.mp4"). |
/videos/ |
vimeo.html |
A video kept on Vimeo, shown as its still until a reader presses play, with its caption where it has one. Takes address. Called as @vimeo("123456789"). |
/videos/ |
youtube.html |
A video kept on YouTube, shown as its still until a reader presses play, with its caption where it has one. Takes address. Called as @youtube("abcdefghijk"). |
/videos/ |
static/
| File | What it is | Described in |
|---|---|---|
favicon.ico |
A sample icon, which browsers show in the site’s tab: put your own in its place. | /assets/ |
templates/
| File | What it is | Described in |
|---|---|---|
404.html |
The page a reader is shown where nothing is published, kept out of search engines. | /feeds/ |
base.html |
The frame every page is built in. | /templates/ |
feed.xml |
The Atom feed of a list’s newest posts. | /feeds/ |
folder.html |
A folder’s page, and the pages Statac makes for a tag and a series. | /lists/ |
home.html |
The home page: what the site is, then the newest of each kind of page. | /templates/ |
note.html |
A note: a short piece with a date and, often, no title. | /templates/ |
notes.html |
The notes’ page, each note shown whole. | /lists/ |
page.html |
A page that isn’t a post, a note, a photograph or a list. | /templates/ |
photo.html |
One photograph: the picture first and wide, then what is written about it. | /templates/ |
photos.html |
The photographs’ page, a grid of them, newest first. | /lists/ |
post.html |
A post: its title, summary and dates, then the writing, what it is filed under, and the posts either side of it and those related to it. | /templates/, /lists/ |
redirect.html |
The page that sends readers on from an old address, kept out of search engines. | /addresses/ |
robots.txt |
What crawlers may read, and where the sitemap is. | /feeds/ |
sitemap.xml |
The sitemap search engines read, every page with its translations. | /feeds/ |
What statac new --cards adds
With --cards, a new site or one already made is given the files its sharing cards are drawn from.
| File | What it is | Described in |
|---|---|---|
templates/og.yaml |
The sharing card drawn for each page. | /sharing-cards/ |
templates/og/NotoEmoji-OFL.txt |
The licence Noto Emoji is given under. | |
templates/og/NotoEmoji.ttf |
The font the card’s emoji are drawn in. | |
templates/og/NotoSans-Regular.ttf |
The font the card’s words are drawn in. | |
templates/og/OFL.txt |
The licence Noto Sans is given under. | |
templates/og/background.png |
The picture every card is drawn on. |
What another language adds
For each of its languages but English, a new site is given a file named by the language’s code.
| File | What it is | Described in |
|---|---|---|
languages/<code>.yaml |
The words Statac shows beside the writing, in English for you to translate. | /dates-and-languages/ |
The words
data/words.yaml holds every word the templates and snippets show readers, under each of the site’s languages, in English until you translate them. A template reads one by its name, as words.older_posts.
| Name | In English |
|---|---|
skip |
Skip to the content |
navigation |
Site |
home |
Home |
latest |
Latest posts |
feed |
RSS feed |
languages |
Languages |
tags |
Tags |
series |
Series: |
tagged |
Posts tagged |
in_series |
Posts in the series |
contents |
Contents |
more_posts |
More posts |
previous |
Previous |
next |
Next |
related |
Related posts |
read_more |
Read more |
pages |
More pages |
newer_posts |
Newer posts |
older_posts |
Older posts |
previous_page |
Previous page |
next_page |
Next page |
mentions |
From other sites |
replied |
replied |
liked |
liked |
reposted |
reposted |
bookmarked |
bookmarked |
mentioned |
mentioned |
play_video |
Play the video |
play |
Play |
video_player |
Video player |
download_video |
Download the video |
download_recording |
Download the recording |
note |
Note |
tip |
Tip |
important |
Important |
warning |
Warning |
caution |
Caution |
moved |
This page has moved to |
not_found |
Page not found |
nothing_here |
Nothing is published at this address. |
go_home |
Go to the home page |
updated |
Updated |
minutes |
min read |
all |
See all |
Something unclear or wrong? Open an issue on GitHub.