vowel 0.6.4 → 0.7.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/bin.js +47 -27
- package/cli.js +15 -0
- package/config.js +93 -26
- package/extractDate.js +70 -6
- package/index.js +14 -5
- package/package.json +39 -8
- package/plugins/assets/index.js +65 -0
- package/plugins/atproto/index.js +132 -0
- package/plugins/atproto/password.js +71 -0
- package/plugins/atproto/publish.js +406 -0
- package/plugins/atproto/record.js +144 -0
- package/plugins/atproto/rkey.js +54 -0
- package/plugins/deploy-cloudflare/index.js +30 -16
- package/plugins/fonts/index.js +18 -21
- package/plugins/html/assets/bundle-BeK1Hptv.css +21 -0
- package/plugins/html/bundle/assets/index-BeK1Hptv.css +21 -0
- package/plugins/html/bundle/index.js +21145 -0
- package/plugins/html/editor/EditButton.svelte +152 -0
- package/plugins/html/editor/Editor.svelte +51 -0
- package/plugins/html/editor/Overlays.svelte +6 -0
- package/plugins/html/editor/SettingsPanel.svelte +397 -0
- package/plugins/html/editor/Toolbar.svelte +644 -0
- package/plugins/html/editor/create-session.js +250 -0
- package/plugins/html/editor/directives.js +128 -0
- package/plugins/html/editor/frontmatter.js +97 -0
- package/plugins/html/editor/ingest.js +339 -0
- package/plugins/html/editor/main.js +94 -0
- package/plugins/html/editor/nodes/Alert.svelte +21 -0
- package/plugins/html/editor/nodes/Blockquote.svelte +9 -0
- package/plugins/html/editor/nodes/CodeBlock.svelte +19 -0
- package/plugins/html/editor/nodes/Embed.svelte +19 -0
- package/plugins/html/editor/nodes/Emphasis.svelte +11 -0
- package/plugins/html/editor/nodes/Heading.svelte +15 -0
- package/plugins/html/editor/nodes/Highlight.svelte +11 -0
- package/plugins/html/editor/nodes/Image.svelte +18 -0
- package/plugins/html/editor/nodes/InlineCode.svelte +11 -0
- package/plugins/html/editor/nodes/Link.svelte +17 -0
- package/plugins/html/editor/nodes/List.svelte +15 -0
- package/plugins/html/editor/nodes/ListItem.svelte +9 -0
- package/plugins/html/editor/nodes/Page.svelte +21 -0
- package/plugins/html/editor/nodes/Paragraph.svelte +9 -0
- package/plugins/html/editor/nodes/Strikethrough.svelte +11 -0
- package/plugins/html/editor/nodes/Strong.svelte +11 -0
- package/plugins/html/editor/nodes/ThematicBreak.svelte +9 -0
- package/plugins/html/editor/nodes/index.js +18 -0
- package/plugins/html/editor/rollup.config.js +35 -0
- package/plugins/html/editor/serialize.js +157 -0
- package/plugins/html/editor/settings-file.js +83 -0
- package/plugins/html/editor/socket.js +202 -0
- package/plugins/html/editor/source.js +43 -0
- package/plugins/html/image.js +31 -5
- package/plugins/html/index.js +430 -458
- package/plugins/html/partials.js +299 -0
- package/plugins/html/socialLinks.js +67 -0
- package/plugins/html/writeRules.js +377 -0
- package/plugins/icons/index.js +2 -6
- package/plugins/images/index.js +78 -55
- package/plugins/markdown/brandColors.js +10 -0
- package/plugins/markdown/colorScheme.js +64 -0
- package/plugins/markdown/emoji.js +30 -0
- package/plugins/markdown/frontmatter.js +253 -0
- package/plugins/markdown/index.js +276 -334
- package/plugins/markdown/links.js +97 -0
- package/plugins/markdown/metadata.js +229 -68
- package/plugins/markdown/readRules.js +143 -0
- package/plugins/markdown/typography.js +109 -0
- package/plugins/markdown/visitor.js +143 -0
- package/plugins/publish/index.js +34 -0
- package/plugins/robots/agents.js +79 -0
- package/plugins/robots/index.js +30 -10
- package/plugins/robots/robots.js +48 -0
- package/plugins/styles/index.js +111 -18
- package/plugins/styles/theme.js +116 -0
- package/plugins/urls/index.js +49 -62
- package/plugins/urls/urlMetadata.js +246 -0
- package/plugins/vectors/index.js +5 -9
- package/plugins/xml/entryContent.js +103 -0
- package/plugins/xml/index.js +105 -43
- package/secretPaths.js +170 -0
- package/stylesheets/DefaultStyles.css +367 -437
- package/stylesheets/ResetStyles.css +2 -38
- package/stylesheets/SyntaxHighlightingStyles.css +36 -4
- package/stylesheets/TypographyStyles.css +386 -128
- package/systemPaths.js +48 -0
- package/utils.js +56 -5
- package/.github/ISSUE_TEMPLATE/bug_report.md +0 -73
- package/.github/ISSUE_TEMPLATE/config.yml +0 -7
- package/docs-source/.cache.json +0 -9
- package/docs-source/.obsidian/app.json +0 -3
- package/docs-source/.obsidian/appearance.json +0 -3
- package/docs-source/.obsidian/core-plugins-migration.json +0 -30
- package/docs-source/.obsidian/core-plugins.json +0 -20
- package/docs-source/.obsidian/workspace.json +0 -168
- package/docs-source/.stackblitzrc +0 -3
- package/docs-source/.votive.db +0 -0
- package/docs-source/about.md +0 -3
- package/docs-source/blog/home.md +0 -5
- package/docs-source/blog/url-ui.md +0 -21
- package/docs-source/blog.md +0 -5
- package/docs-source/docs/.votive.db +0 -0
- package/docs-source/docs/deploy.md +0 -67
- package/docs-source/docs/file-structure.md +0 -31
- package/docs-source/docs/folder-settings.md +0 -23
- package/docs-source/docs/home.md +0 -55
- package/docs-source/docs/images.md +0 -10
- package/docs-source/docs/items.md +0 -13
- package/docs-source/docs/pages.md +0 -141
- package/docs-source/docs/settings.md +0 -4
- package/docs-source/docs/styling.md +0 -34
- package/docs-source/docs/taxonomies.md +0 -37
- package/docs-source/features/cards.md +0 -7
- package/docs-source/features/editing.md +0 -7
- package/docs-source/features/emoji.md +0 -7
- package/docs-source/features/frontmatter.md +0 -7
- package/docs-source/features/lists.md +0 -7
- package/docs-source/features/navigation.md +0 -7
- package/docs-source/features/rich-previews.md +0 -7
- package/docs-source/features/robots.md +0 -7
- package/docs-source/features/rss.md +0 -7
- package/docs-source/features/sitemap.md +0 -7
- package/docs-source/features/speed.md +0 -7
- package/docs-source/features/static.md +0 -7
- package/docs-source/features/taxonomies.md +0 -7
- package/docs-source/home.md +0 -42
- package/docs-source/output/about.html +0 -1
- package/docs-source/output/blog/url-ui.html +0 -8
- package/docs-source/output/blog.html +0 -1
- package/docs-source/output/default.css +0 -1
- package/docs-source/output/docs/deploy.html +0 -34
- package/docs-source/output/docs/file-structure.html +0 -24
- package/docs-source/output/docs/folder-settings.html +0 -20
- package/docs-source/output/docs/images.html +0 -2
- package/docs-source/output/docs/items.html +0 -6
- package/docs-source/output/docs/pages.html +0 -101
- package/docs-source/output/docs/styling.html +0 -18
- package/docs-source/output/docs/taxonomies.html +0 -20
- package/docs-source/output/docs.html +0 -28
- package/docs-source/output/features/cards.html +0 -1
- package/docs-source/output/features/editing.html +0 -1
- package/docs-source/output/features/emoji.html +0 -1
- package/docs-source/output/features/frontmatter.html +0 -1
- package/docs-source/output/features/lists.html +0 -1
- package/docs-source/output/features/navigation.html +0 -1
- package/docs-source/output/features/rich-previews.html +0 -1
- package/docs-source/output/features/robots.html +0 -1
- package/docs-source/output/features/rss.html +0 -1
- package/docs-source/output/features/sitemap.html +0 -1
- package/docs-source/output/features/speed.html +0 -1
- package/docs-source/output/features/static.html +0 -1
- package/docs-source/output/features/taxonomies.html +0 -1
- package/docs-source/output/features.html +0 -1
- package/docs-source/output/feed.xml +0 -1
- package/docs-source/output/index.html +0 -21
- package/docs-source/output/reset.css +0 -1
- package/docs-source/output/roadmap.html +0 -87
- package/docs-source/output/robots.txt +0 -14
- package/docs-source/output/sitemap.xml +0 -16
- package/docs-source/output/typography.css +0 -1
- package/docs-source/roadmap.md +0 -98
- package/docs-source/settings.md +0 -13
- package/getMetadata.js +0 -41
- package/jsconfig.json +0 -10
- package/plugins/markdown/robots.js +0 -18
- package/regex.js +0 -36
- package/stylesheets/brand-colors.css +0 -119
|
@@ -1,141 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Pages
|
|
3
|
-
description: Create content.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
The `body` element on each page has a class representing the current page. The homepage has classes `"page home"`, while a blog post might have `"page blog-hello-world"`.
|
|
7
|
-
|
|
8
|
-
Vowel attempts to construct a logical semantic HTML structure based on the files and folders in your website.
|
|
9
|
-
|
|
10
|
-
To do this, Vowel distinguishes between evergreen pages and ephemeral pages. A page with a `date` property is considered ephemeral, so it is excluded from the navigation and sitemap.
|
|
11
|
-
|
|
12
|
-
Vowel will automatically create a multi-level nav, with one level for each parent folder for the current page.
|
|
13
|
-
|
|
14
|
-
Vowel will create a full side navigation that displays all evergreen pages.
|
|
15
|
-
|
|
16
|
-
# Frontmatter
|
|
17
|
-
|
|
18
|
-
Reserved properties
|
|
19
|
-
|
|
20
|
-
- `title`: Page title
|
|
21
|
-
- `image`: Page image
|
|
22
|
-
- `description`: Page description
|
|
23
|
-
- `date`: Date published
|
|
24
|
-
- `breadcrumb`: Short identifier for the page
|
|
25
|
-
- `toc`: Optionally display a table of contents
|
|
26
|
-
|
|
27
|
-
Vowel will attempt to impute the type of each frontmatter property. Imputed types include:
|
|
28
|
-
|
|
29
|
-
- Links (Will generate a link preview)
|
|
30
|
-
- Images (will display the image)
|
|
31
|
-
- Date (will render a pretty date in a `time` element)
|
|
32
|
-
|
|
33
|
-
You can also use lists and objects in frontmatter.
|
|
34
|
-
|
|
35
|
-
# Markdown
|
|
36
|
-
|
|
37
|
-
Vowel comes loaded with GFM (Github-flavored Markdown):
|
|
38
|
-
|
|
39
|
-
```
|
|
40
|
-
## Autolink literals
|
|
41
|
-
|
|
42
|
-
www.example.com, https://example.com, and contact@example.com.
|
|
43
|
-
|
|
44
|
-
## Footnote
|
|
45
|
-
|
|
46
|
-
A note[^1]
|
|
47
|
-
|
|
48
|
-
[^1]: Big note.
|
|
49
|
-
|
|
50
|
-
## Strikethrough
|
|
51
|
-
|
|
52
|
-
~one~ or ~~two~~ tildes.
|
|
53
|
-
|
|
54
|
-
## Table
|
|
55
|
-
|
|
56
|
-
| a | b | c | d |
|
|
57
|
-
| - | :- | -: | :-: |
|
|
58
|
-
|
|
59
|
-
## Tasklist
|
|
60
|
-
|
|
61
|
-
* [ ] to do
|
|
62
|
-
* [x] done
|
|
63
|
-
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
Along with all standard Markdown, Vowel also allows the following special elements:
|
|
67
|
-
|
|
68
|
-
## Rich link previews
|
|
69
|
-
|
|
70
|
-
Paste a URL on its own line (e.g. `https://example.com`).
|
|
71
|
-
|
|
72
|
-
## Internal link previews
|
|
73
|
-
|
|
74
|
-
Paste a relative path to a page (e.g. `/about`).
|
|
75
|
-
|
|
76
|
-
The link will be rendered as an `article` element with a class representing the linked path (e.g. `page-blog-hello-world`).
|
|
77
|
-
|
|
78
|
-
## Page lists
|
|
79
|
-
|
|
80
|
-
A relative path to a folder with a `count` parameter (e.g. `/blog?count=2`). This will exclude the `home.md` file for the folder. In this example, it would return the `/blog/hello-world.md` file but not `/blog/home.md`.
|
|
81
|
-
|
|
82
|
-
The page list will order pages first by date in reverse chronology (newest to oldest) and then alphabetically (a to z).
|
|
83
|
-
|
|
84
|
-
The list will be rendered as `article` elements (see above) in a `section` element. The `section` element will have a class representing the folder path (e.g. `folder-blog`).
|
|
85
|
-
|
|
86
|
-
## Headings
|
|
87
|
-
|
|
88
|
-
If your document starts with an `h1` (`#`) and has no `title` property, the `h1` will be used as the meta title.
|
|
89
|
-
|
|
90
|
-
If your document includes `h1`s after the title, all headings will be demoted one level (`#` to `h2`, `##` to `h3`).
|
|
91
|
-
|
|
92
|
-
## Description
|
|
93
|
-
|
|
94
|
-
If your document doesn't include a `description`, a meta description will be extracted from the text.
|
|
95
|
-
|
|
96
|
-
## Notes
|
|
97
|
-
|
|
98
|
-
Highlight information with note boxes:
|
|
99
|
-
|
|
100
|
-
```
|
|
101
|
-
:::tip
|
|
102
|
-
Use `tip` for power-ups.
|
|
103
|
-
:::
|
|
104
|
-
|
|
105
|
-
:::note
|
|
106
|
-
Use `note` for good-to-know information.
|
|
107
|
-
:::
|
|
108
|
-
|
|
109
|
-
:::important
|
|
110
|
-
Use `important` to help guide your user down the right path.
|
|
111
|
-
:::
|
|
112
|
-
|
|
113
|
-
:::warning
|
|
114
|
-
Use `warning` to help your user avoid the wrong path.
|
|
115
|
-
:::
|
|
116
|
-
|
|
117
|
-
:::caution
|
|
118
|
-
Use `caution` to alert the user before they perform a destructive action.
|
|
119
|
-
:::
|
|
120
|
-
|
|
121
|
-
```
|
|
122
|
-
|
|
123
|
-
:::tip
|
|
124
|
-
Use `tip` for power-ups.
|
|
125
|
-
:::
|
|
126
|
-
|
|
127
|
-
:::note
|
|
128
|
-
Use `note` for good-to-know information.
|
|
129
|
-
:::
|
|
130
|
-
|
|
131
|
-
:::important
|
|
132
|
-
Use `important` to help guide your user down the right path.
|
|
133
|
-
:::
|
|
134
|
-
|
|
135
|
-
:::warning
|
|
136
|
-
Use `warning` to help your user avoid the wrong path.
|
|
137
|
-
:::
|
|
138
|
-
|
|
139
|
-
:::caution
|
|
140
|
-
Use `caution` to alert the user before they perform a destructive action.
|
|
141
|
-
:::
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Styling
|
|
3
|
-
description: Add styles to your website.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
Vowel allows styling through themes and vanilla CSS.
|
|
7
|
-
|
|
8
|
-
## Themes
|
|
9
|
-
|
|
10
|
-
Vowel includes a default theme, but you can disable this in your root `settings.md` file:
|
|
11
|
-
```
|
|
12
|
-
theme: none
|
|
13
|
-
```
|
|
14
|
-
You also have two other themes available:
|
|
15
|
-
- `reset`: A classic CSS reset
|
|
16
|
-
- `typography`: A classic CSS reset, plus some basic text styling
|
|
17
|
-
|
|
18
|
-
## CSS
|
|
19
|
-
|
|
20
|
-
Create an `assets/styles.css` file for your styling. We recommend using a style framework like Pico or Open Props. You can simply download their stylesheet and either copy-paste it into your own or include it in `assets/` and `import` it into `assets/styles.css`.
|
|
21
|
-
|
|
22
|
-
For some inspiration on how to style semantic HTML, check out Swyx's [Spark Joy repository](https://github.com/swyxio/spark-joy).
|
|
23
|
-
|
|
24
|
-
:::tip
|
|
25
|
-
|
|
26
|
-
You can combine a theme with your own CSS. Feel free to use the `reset` or `typography` theme as a starting point and build from there.
|
|
27
|
-
|
|
28
|
-
:::
|
|
29
|
-
|
|
30
|
-
:::warning
|
|
31
|
-
|
|
32
|
-
This project is still in development, so the generated markup is likely to change quickly and without warning, which will likely affect your styles.
|
|
33
|
-
|
|
34
|
-
:::
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Taxonomies
|
|
3
|
-
description: Create tags, categories, and authors.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
If the key for a frontmatter property matches a folder at the root of your project, Vowel will attempt to treat it as a taxonomy and link to the respective page.
|
|
7
|
-
|
|
8
|
-
For instance, in this folder structure:
|
|
9
|
-
|
|
10
|
-
```
|
|
11
|
-
.
|
|
12
|
-
├── home.md
|
|
13
|
-
├── design.md
|
|
14
|
-
├── recipes.md
|
|
15
|
-
└── category/
|
|
16
|
-
├── inspiration.md
|
|
17
|
-
└── lifestyle.md
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
You can write the following frontmatter in `design.md`:
|
|
21
|
-
|
|
22
|
-
```
|
|
23
|
-
---
|
|
24
|
-
title: Design
|
|
25
|
-
category: inspiration
|
|
26
|
-
---
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
Vowel will render the property as a link to `/category/inspiration`.
|
|
30
|
-
|
|
31
|
-
Then, in `category/inspiration.md` (or anywhere) you can display all inspiration posts with a post list:
|
|
32
|
-
|
|
33
|
-
```
|
|
34
|
-
/?property=category.inspiration
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
This allows you to create author pages, category pages.
|
package/docs-source/home.md
DELETED
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
# Home
|
|
2
|
-
|
|
3
|
-
Vowel is a very simple Markdown- and CSS-based website generator.
|
|
4
|
-
|
|
5
|
-
:::tip
|
|
6
|
-
|
|
7
|
-
Start editing this page with one click by [opening it on StackBlitz](https://stackblitz.com/~/github.com/samlfair/vowel-site?file=home.md).
|
|
8
|
-
|
|
9
|
-
:::
|
|
10
|
-
|
|
11
|
-
To try Vowel out on your own computer, `cd` into a directory of markdown files and run:
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
npx -y -p svelte@next -p vowel@latest npx vowel
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
(This `npx` command forces the Svelte 5 peer depedency, without which the app will throw an error.)
|
|
18
|
-
|
|
19
|
-
 Here's a photo
|
|
20
|
-
|
|
21
|
-
Vowel is a minimal website framework for developers who love to write CSS and read RSS.
|
|
22
|
-
|
|
23
|
-
> Here's a lovely block quote.
|
|
24
|
-
|
|
25
|
-
Vowel will generate a feature-rich HTML website from a directory of markdown files. The output is plain HTML. You can style it however you want with your own CSS.
|
|
26
|
-
|
|
27
|
-
:::warning
|
|
28
|
-
|
|
29
|
-
This project is still in early development. There are many bugs and the API is changing quickly.
|
|
30
|
-
|
|
31
|
-
:::
|
|
32
|
-
|
|
33
|
-
Vowel is created by Sam Littlefair. If you have questions or comments, [reach out to me on Twitter](https://twitter.com/samlfair).
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
# Features
|
|
37
|
-
|
|
38
|
-
/features/*
|
|
39
|
-
|
|
40
|
-
# Try it
|
|
41
|
-
|
|
42
|
-
/docs
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
<!doctypehtml><html lang=en><meta charset=UTF-8><meta name=viewport content="width=device-width, initial-scale=1.0"><meta http-equiv=X-UA-Compatible content=ie-edge><title>About - Vowel</title><meta property=og:title content="About - Vowel"><meta property=og:description content="This is an about page."><meta property=og:url content=/about><link rel=stylesheet href=/default.css?47tfcu05><link rel=stylesheet href=/reset.css?bg1gg3lc><link rel=stylesheet href=/typography.css?z0u4qr1t><meta property=og:site_name><body class=about><header><a class=title href=/ rel=home>Vowel</a><p class=slogan>The easiest way to code a website<nav><a href=/about aria-current=page>About</a><a href=/blog>Blog</a><a href=/docs>Docs</a><a href=/features>Features</a><a href=/roadmap>Roadmap</a></nav></header><main><nav aria-label=Breadcrumbs><a href=/>Home</a><a href=/about aria-current=page>About</a></nav><h1>About</h1><p itemprop=description>This is an about page.<nav aria-label=Contents><ol class="toc-level toc-level-1"></ol></nav></main><aside><nav><ul><li><a href=index.html>Home</a><li><a href=/about.html>About</a><li><a href=/blog.html>Blog</a><ul><li><a href=/blog/url-ui.html>Long Live the URL</a></ul><li><a href=/docs.html>Docs</a><ul><li><a href=/docs/deploy.html>Deploy</a><li><a href=/docs/file-structure.html>Files</a><li><a href=/docs/folder-settings.html>Folders</a><li><a href=/docs/images.html>Images</a><li><a href=/docs/items.html>Items</a><li><a href=/docs/pages.html>Pages</a><li><a href=/docs/styling.html>Styling</a><li><a href=/docs/taxonomies.html>Taxonomies</a></ul><li><a href=/features.html>Features</a><ul><li><a href=/features/cards.html>Cards</a><li><a href=/features/editing.html>Live editing</a><li><a href=/features/emoji.html>Emoji favicons</a><li><a href=/features/frontmatter.html>Frontmatter</a><li><a href=/features/lists.html>Blog</a><li><a href=/features/navigation.html>Navigation</a><li><a href=/features/rich-previews.html>Rich link previews</a><li><a href=/features/robots.html>Robots</a><li><a href=/features/rss.html>RSS</a><li><a href=/features/sitemap.html>Sitemap</a><li><a href=/features/speed.html>Speed</a><li><a href=/features/static.html>Static generation</a><li><a href=/features/taxonomies.html>Taxonomies</a></ul><li><a href=/roadmap.html>Roadmap</a></ul></nav></aside><footer><section class=copyright>© 2026</section><section class=shoutout>Made with <a href=https://vowel.cc>Vowel</a></section></footer>
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
<!doctypehtml><html lang=en><meta charset=UTF-8><meta name=viewport content="width=device-width, initial-scale=1.0"><meta http-equiv=X-UA-Compatible content=ie-edge><title>Long Live the URL - Vowel</title><meta property=og:title content="Long Live the URL - Vowel"><meta property=og:description content="This article from 1999 about how to write good URLs is awesome. Some tips:"><meta property=og:url content=/blog/url-ui><link rel=stylesheet href=/default.css?c8247kf4><link rel=stylesheet href=/reset.css?8xnhn2cn><link rel=stylesheet href=/typography.css?i5lk5yqt><meta property=og:image content=./dog.jpeg><meta property=og:site_name><body class=blog_url-ui><header><a class=title href=/ rel=home>Vowel</a><p class=slogan>The easiest way to code a website<nav><a href=/about>About</a><a href=/blog>Blog</a><a href=/docs>Docs</a><a href=/features>Features</a><a href=/roadmap>Roadmap</a></nav></header><main><nav aria-label=Breadcrumbs><a href=/>Home</a><a href=/blog/>Blog</a><a href=/blog/url-ui aria-current=page>Long Live the URL</a></nav><h1>Long Live the URL</h1><time datetime=2024-06-27T03:00:00.000Z itemprop=date>June 27, 2024</time><img src=./dog.jpeg itemprop=image><p itemprop=description>This article from 1999 about how to write good URLs is awesome. Some tips:<nav aria-label=Contents><ol class="toc-level toc-level-1"></ol></nav><ul>
|
|
2
|
-
<li>Write in lowercase
|
|
3
|
-
<li>Check for typos
|
|
4
|
-
<li>URLs should be permanent
|
|
5
|
-
<li>Keep URLs short
|
|
6
|
-
</ul>
|
|
7
|
-
<p>But Nielsen's overall view is that URLs are an important part of user experience. They contribute to a website visitor's sense of trust and geography. One of Neilsen's rules dictates that a user should be able to "hack" of the last segment of a URL to get to the parent page.
|
|
8
|
-
<p>Ironically, in 1999 Nielsen thought that URLs and search engines would soon fade into obscurity as better solutions to information management emerged. Lo, 25 years later the URL remains more important than ever. Sometimes the simple solutions is the best one.</main><aside><nav><ul><li><a href=index.html>Home</a><li><a href=/about.html>About</a><li><a href=/blog.html>Blog</a><ul><li><a href=/blog/url-ui.html>Long Live the URL</a></ul><li><a href=/docs.html>Docs</a><ul><li><a href=/docs/deploy.html>Deploy</a><li><a href=/docs/file-structure.html>Files</a><li><a href=/docs/folder-settings.html>Folders</a><li><a href=/docs/images.html>Images</a><li><a href=/docs/items.html>Items</a><li><a href=/docs/pages.html>Pages</a><li><a href=/docs/styling.html>Styling</a><li><a href=/docs/taxonomies.html>Taxonomies</a></ul><li><a href=/features.html>Features</a><ul><li><a href=/features/cards.html>Cards</a><li><a href=/features/editing.html>Live editing</a><li><a href=/features/emoji.html>Emoji favicons</a><li><a href=/features/frontmatter.html>Frontmatter</a><li><a href=/features/lists.html>Blog</a><li><a href=/features/navigation.html>Navigation</a><li><a href=/features/rich-previews.html>Rich link previews</a><li><a href=/features/robots.html>Robots</a><li><a href=/features/rss.html>RSS</a><li><a href=/features/sitemap.html>Sitemap</a><li><a href=/features/speed.html>Speed</a><li><a href=/features/static.html>Static generation</a><li><a href=/features/taxonomies.html>Taxonomies</a></ul><li><a href=/roadmap.html>Roadmap</a></ul></nav></aside><footer><section class=copyright>© 2026</section><section class=shoutout>Made with <a href=https://vowel.cc>Vowel</a></section></footer>
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
<!doctypehtml><html lang=en><meta charset=UTF-8><meta name=viewport content="width=device-width, initial-scale=1.0"><meta http-equiv=X-UA-Compatible content=ie-edge><title>Blog - Vowel</title><meta property=og:title content="Blog - Vowel"><meta property=og:description content="Here's a blog."><meta property=og:url content=/blog><link rel=stylesheet href=/default.css?gdz9k908><link rel=stylesheet href=/reset.css?p2z8rcu0><link rel=stylesheet href=/typography.css?7h47d6pa><meta property=og:site_name><body class=blog><header><a class=title href=/ rel=home>Vowel</a><p class=slogan>The easiest way to code a website<nav><a href=/about>About</a><a href=/blog aria-current=page>Blog</a><a href=/docs>Docs</a><a href=/features>Features</a><a href=/roadmap>Roadmap</a></nav></header><main><nav aria-label=Breadcrumbs><a href=/>Home</a><a href=/blog aria-current=page>Blog</a></nav><h1>Blog</h1><p itemprop=description>Here's a blog.<nav aria-label=Contents><ol class="toc-level toc-level-1"></ol></nav><section><article><a href=/blog/url-ui><h1>Long Live the URL</h1><time datetime=2024-06-27T03:00:00.000Z itemprop=date>June 27, 2024</time><img src=./dog.jpeg itemprop=image><p itemprop=description>This article from 1999 about how to write good URLs is awesome. Some tips:</p></a></article></section></main><aside><nav><ul><li><a href=index.html>Home</a><li><a href=/about.html>About</a><li><a href=/blog.html>Blog</a><ul><li><a href=/blog/url-ui.html>Long Live the URL</a></ul><li><a href=/docs.html>Docs</a><ul><li><a href=/docs/deploy.html>Deploy</a><li><a href=/docs/file-structure.html>Files</a><li><a href=/docs/folder-settings.html>Folders</a><li><a href=/docs/images.html>Images</a><li><a href=/docs/items.html>Items</a><li><a href=/docs/pages.html>Pages</a><li><a href=/docs/styling.html>Styling</a><li><a href=/docs/taxonomies.html>Taxonomies</a></ul><li><a href=/features.html>Features</a><ul><li><a href=/features/cards.html>Cards</a><li><a href=/features/editing.html>Live editing</a><li><a href=/features/emoji.html>Emoji favicons</a><li><a href=/features/frontmatter.html>Frontmatter</a><li><a href=/features/lists.html>Blog</a><li><a href=/features/navigation.html>Navigation</a><li><a href=/features/rich-previews.html>Rich link previews</a><li><a href=/features/robots.html>Robots</a><li><a href=/features/rss.html>RSS</a><li><a href=/features/sitemap.html>Sitemap</a><li><a href=/features/speed.html>Speed</a><li><a href=/features/static.html>Static generation</a><li><a href=/features/taxonomies.html>Taxonomies</a></ul><li><a href=/roadmap.html>Roadmap</a></ul></nav></aside><footer><section class=copyright>© 2026</section><section class=shoutout>Made with <a href=https://vowel.cc>Vowel</a></section></footer>
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
@layer reset,typography;@layer default{:root{--text-color:#212121;--accent-color:#004ab3;--accent-color-hover:#1e6ddc;--border-color:#bababa;--main-background:#fff;--code-background:#f2f2f2;--soft-background:#f2f2f2}@media (prefers-color-scheme:dark){:root{--text-color:#ccc;--accent-color:#1eb0dc;--accent-color-hover:#33c4f0;--border-color:#454545;--main-background:#1f1f1f;--code-background:#0d0d0d;--soft-background:#242424}}body{font-family:var(--font-sans);flex-flow:row-reverse wrap;align-content:start;justify-items:center;gap:4rem 1rem;max-width:min(100ch,100vi - 10vw);margin-inline:auto;display:flex;overflow-y:scroll;& header{flex-basis:100%}& main{flex:60ch}& aside{flex:100%}& footer{min-width:100%}}main,article{flex-flow:wrap;align-items:baseline;column-gap:.5rem;margin-bottom:auto;padding-bottom:4rem;display:flex}:is(main,article)>*{flex-basis:100%}:is(main,article) :is(time,dl:not(.link)){opacity:.8;font-size:.9em}dt{display:none}dd{display:inline}html{color:var(--text-color);background:var(--main-background)}a:where(:not([rel=home])){color:var(--accent-color);&:hover{color:var(--accent-color-hover)}}code,pre{background:var(--code-background)}blockquote{border-left:5px solid var(--border-color)}article{border:1px solid var(--border-color);background:var(--soft-background);border-radius:calc(1rem + 5px);flex-direction:column;padding:2rem;display:flex}th,td{border-bottom:1px solid var(--border-color-softer)}hr{border-top:1px solid var(--text-color)}main>img{margin-bottom:2.5rem}dt{font-size:1.1em}dl.link dt{display:none}dl.link{order:calc(Infinity);margin-top:2.5rem;margin-bottom:0}dl.tags,time{font-size:1.1em}dl.tags dt{display:none}dl.tags :is(dd,ul,li){padding-inline:0;display:inline}dl.tags li{margin-inline:.2em}dl.tags li:before{content:"#"}dl.contents ul{padding:0;list-style:none}dl.contents .depth-2{font-weight:500}dl.contents .depth-3{padding-left:.5em;font-size:.95em}nav[aria-label=Contents]:has(>ol:empty){display:none}nav[aria-label=Contents]{background:var(--soft-background);border:1px solid var(--border-color);border-radius:2px;flex-basis:30%;min-width:max-content;max-width:100%;margin-bottom:2.5em;padding:.8em 1.2em;&:before{content:"Contents";width:max-content;margin-bottom:.5em;font-weight:600;display:block}& ol{width:max-content;margin:0;padding:0;list-style:none;& ol{margin-left:1em}}}header{flex-flow:wrap;align-items:center;column-gap:1em;margin-top:4rem;display:flex;& p.slogan{align-self:flex-end;margin-bottom:.5em;margin-left:auto;font-size:1.5em}& nav{border:1px solid var(--border-color);width:100%;padding:0 6px;&:first-of-type{padding-top:7px}&:last-of-type{padding-bottom:7px}background:var(--soft-background);border-radius:5px;flex-wrap:wrap;justify-content:flex-start;column-gap:2rem;margin-inline:-3px;display:flex}& nav:has(+nav){border-bottom:none;border-bottom-right-radius:0;border-bottom-left-radius:0;&:after{content:"";border-bottom:1px solid var(--border-color);flex-basis:100%;margin-block:.7rem;display:block}}& nav+nav{border-top:none;border-top-left-radius:0;border-top-right-radius:0;margin-top:0}}nav[aria-label=Breadcrumbs]>a:only-child{display:none}nav[aria-label=Breadcrumbs]{text-transform:uppercase;color:var(--border-color);& a{color:unset}}aside nav{margin-inline:auto;&>ul{flex-direction:row;justify-content:center;gap:2em;display:flex}& ul{padding-left:0;list-style:none}& li{margin:0;line-height:1.7em}&>ul>li{&>a{font-weight:500}&>ul{font-size:.9em;line-height:1.2em;& ul{padding-left:1em}}}}footer{text-align:center}p:where([itemprop=description]){color:light-dark(oklch(from currentColor calc(l + .2) c h),oklch(from currentColor calc(l - .2) c h));font-size:1.3em}article a{flex-direction:column;row-gap:1em;display:flex;&>*{margin:0}}article img{order:-1}article a,article a:hover{color:unset}article h1{grid-area:title;font-size:1.6rem}article p{font-size:1.6rem}article dl.icon{grid-area:icon;font-size:1.5em}article dl.icon dd{text-align:right}article .description{grid-area:description}article dt{display:none}article dl.icon{order:-1}aside.alert.note{--icon:"ℹ️";--rgb:71, 139, 230}aside.alert.tip{--icon:"💡";--rgb:87, 171, 90}aside.alert.important{--icon:"💬";--rgb:152, 110, 226}aside.alert.warning{--icon:"⚠️";--rgb:198, 144, 38}aside.alert.caution{--icon:"⛔️";--rgb:229, 83, 75}aside.alert{border-left:3px solid rgb(var(--rgb));background:rgba(var(--rgb), .04);padding:1.5rem 2rem}aside.alert h2{color:rgb(var(--rgb))}aside.alert h2:before{opacity:.9;content:var(--icon);margin-right:.7rem;font-size:.8em}}img{border-radius:5px}
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
<!doctypehtml><html lang=en><meta charset=UTF-8><meta name=viewport content="width=device-width, initial-scale=1.0"><meta http-equiv=X-UA-Compatible content=ie-edge><title>Deploy - Documentation - Vowel</title><meta property=og:title content="Deploy - Documentation - Vowel"><meta property=og:description content="Get going."><meta property=og:url content=/docs/deploy><link rel=stylesheet href=/default.css?bq97ngho><link rel=stylesheet href=/reset.css?fsu4xldi><link rel=stylesheet href=/typography.css?kj95bs00><meta property=og:site_name><body class=docs_deploy><header><a class=title href=/ rel=home>Vowel</a><p class=slogan>The easiest way to code a website<nav><a href=/about>About</a><a href=/blog>Blog</a><a href=/docs>Docs</a><a href=/features>Features</a><a href=/roadmap>Roadmap</a></nav><nav><a href=/docs/deploy aria-current=page>Deploy</a><a href=/docs/file-structure>Files</a><a href=/docs/folder-settings>Folders</a><a href=/docs/images>Images</a><a href=/docs/items>Items</a><a href=/docs/pages>Pages</a><a href=/docs/styling>Styling</a><a href=/docs/taxonomies>Taxonomies</a></nav></header><main><nav aria-label=Breadcrumbs><a href=/>Home</a><a href=/docs/>Docs</a><a href=/docs/deploy aria-current=page>Deploy</a></nav><h1>Deploy</h1><p itemprop=description>Get going.<nav aria-label=Contents><ol class="toc-level toc-level-1"><li class="toc-item toc-item-h1"><a class="toc-link toc-link-h1"href=#github>GitHub</a><ol class="toc-level toc-level-2"><li class="toc-item toc-item-h2"><a class="toc-link toc-link-h2"href=#npx>npx</a><li class="toc-item toc-item-h2"><a class="toc-link toc-link-h2"href=#npm>npm</a></ol></ol></nav><p><strong>Note on URLs:</strong> This guide includes instructions for Vercel, which specify a deploy option called <code>cleanUrls</code>. This will trim the <code>.html</code> extension from your deployment URLs. If you configure your own deploy, ensure you use clean URLs or your links will not work.
|
|
2
|
-
|
|
3
|
-
<p>If you have a GitHub repository of Markdown files, you can deploy them on Vercel automatically on changes.
|
|
4
|
-
<p>Add a <code>vercel.json</code> file to the root of your project with the following contents:
|
|
5
|
-
<pre><code class=language-js>{
|
|
6
|
-
"cleanUrls": true,
|
|
7
|
-
"outputDirectory": ".output",
|
|
8
|
-
"buildCommand": "npx -p svelte@next -p vowel@latest npx vowel build"
|
|
9
|
-
}
|
|
10
|
-
</code></pre>
|
|
11
|
-
<p>Then create a new Vercel project and connect your GitHub repository.
|
|
12
|
-
<p>When you push changes to your repository, your Vercel project will automatically rebuild.
|
|
13
|
-
<h2 id=npx>npx</h2>
|
|
14
|
-
<p>You can manually build your project with <code>npx</code>. Run this command:
|
|
15
|
-
<pre><code>npx -y -p svelte@next -p vowel@latest npx vowel build
|
|
16
|
-
</code></pre>
|
|
17
|
-
<p>The build command will create a <code>vercel.json</code> file at the root of your project with the necessary configuration for a Vercel deploy. Now deploy to Vercel:
|
|
18
|
-
<pre><code>npx vercel --prod
|
|
19
|
-
</code></pre>
|
|
20
|
-
<p>(The <code>--prod</code> flag will deploy to production.)
|
|
21
|
-
<p>If you don't want to use the Vercel CLI, you can deploy the <code>.output</code> directory to any server that supports static HTML.
|
|
22
|
-
<h2 id=npm>npm</h2>
|
|
23
|
-
<p>If you set up your project with npm, you can include a <code>build</code> command in your <code>package.json</code>:
|
|
24
|
-
<pre><code class=language-diff> "scripts": {
|
|
25
|
-
"dev": "vowel",
|
|
26
|
-
+ "build": "vowel build"
|
|
27
|
-
},
|
|
28
|
-
</code></pre>
|
|
29
|
-
<p>Run <code>npm run build</code> (<code>vowel build</code>) to build your website.
|
|
30
|
-
<p>Now you can deploy to Vercel:
|
|
31
|
-
<pre><code>npx vercel --prod
|
|
32
|
-
</code></pre>
|
|
33
|
-
<p>(The <code>--prod</code> flag will deploy to production.)
|
|
34
|
-
<p>If you don't want to use the Vercel CLI, you can deploy the <code>.output</code> directory to any server that supports static HTML.</main><aside><nav><ul><li><a href=index.html>Home</a><li><a href=/about.html>About</a><li><a href=/blog.html>Blog</a><ul><li><a href=/blog/url-ui.html>Long Live the URL</a></ul><li><a href=/docs.html>Docs</a><ul><li><a href=/docs/deploy.html>Deploy</a><li><a href=/docs/file-structure.html>Files</a><li><a href=/docs/folder-settings.html>Folders</a><li><a href=/docs/images.html>Images</a><li><a href=/docs/items.html>Items</a><li><a href=/docs/pages.html>Pages</a><li><a href=/docs/styling.html>Styling</a><li><a href=/docs/taxonomies.html>Taxonomies</a></ul><li><a href=/features.html>Features</a><ul><li><a href=/features/cards.html>Cards</a><li><a href=/features/editing.html>Live editing</a><li><a href=/features/emoji.html>Emoji favicons</a><li><a href=/features/frontmatter.html>Frontmatter</a><li><a href=/features/lists.html>Blog</a><li><a href=/features/navigation.html>Navigation</a><li><a href=/features/rich-previews.html>Rich link previews</a><li><a href=/features/robots.html>Robots</a><li><a href=/features/rss.html>RSS</a><li><a href=/features/sitemap.html>Sitemap</a><li><a href=/features/speed.html>Speed</a><li><a href=/features/static.html>Static generation</a><li><a href=/features/taxonomies.html>Taxonomies</a></ul><li><a href=/roadmap.html>Roadmap</a></ul></nav></aside><footer><section class=copyright>© 2026</section><section class=shoutout>Made with <a href=https://vowel.cc>Vowel</a></section></footer>
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
<!doctypehtml><html lang=en><meta charset=UTF-8><meta name=viewport content="width=device-width, initial-scale=1.0"><meta http-equiv=X-UA-Compatible content=ie-edge><title>File structure - Documentation - Vowel</title><meta property=og:title content="File structure - Documentation - Vowel"><meta property=og:description content="Organize your files."><meta property=og:url content=/docs/file-structure><link rel=stylesheet href=/default.css?4ke3uiwc><link rel=stylesheet href=/reset.css?wdx8q8xm><link rel=stylesheet href=/typography.css?nfgslefd><meta property=og:site_name><body class=docs_file-structure><header><a class=title href=/ rel=home>Vowel</a><p class=slogan>The easiest way to code a website<nav><a href=/about>About</a><a href=/blog>Blog</a><a href=/docs>Docs</a><a href=/features>Features</a><a href=/roadmap>Roadmap</a></nav><nav><a href=/docs/deploy>Deploy</a><a href=/docs/file-structure aria-current=page>Files</a><a href=/docs/folder-settings>Folders</a><a href=/docs/images>Images</a><a href=/docs/items>Items</a><a href=/docs/pages>Pages</a><a href=/docs/styling>Styling</a><a href=/docs/taxonomies>Taxonomies</a></nav></header><main><nav aria-label=Breadcrumbs><a href=/>Home</a><a href=/docs/>Docs</a><a href=/docs/file-structure aria-current=page>Files</a></nav><h1>File structure</h1><p itemprop=description>Organize your files.<nav aria-label=Contents><ol class="toc-level toc-level-1"></ol></nav><p>Almost every file and folder represents a page on your website:
|
|
2
|
-
<ul>
|
|
3
|
-
<li><code>home.md</code> is your homepage, <code>/</code>
|
|
4
|
-
<li><code>about.md</code> would be your about page, <code>/about</code>
|
|
5
|
-
<li><code>blog/home.md</code> would be your blog homepage, <code>/blog</code>
|
|
6
|
-
<li><code>blog/hello-world.md</code> would be a blog post, <code>/blog/hello-world</code>
|
|
7
|
-
</ul>
|
|
8
|
-
<p>(File names like <code>Hello World.md</code> also seem to work fine so far.))
|
|
9
|
-
<p>Even if a folder doesn't have a <code>home.md</code> file, it will still generate a page, so long as it contains any markdown files. So, if you have a <code>blog</code> folder with posts inside it, Vowel will generate a <code>/blog</code> homepage even if you don't have a <code>/blog/home.md</code> file.
|
|
10
|
-
<p>There are a few special files and folders:
|
|
11
|
-
<ul>
|
|
12
|
-
<li><code>assets/</code> contains some static files
|
|
13
|
-
<ul>
|
|
14
|
-
<li><code>assets/styles.css</code> contains your stylesheet, which will be automatically applied if present
|
|
15
|
-
<li><code>assets/favicon.png</code> is your favicon
|
|
16
|
-
</ul>
|
|
17
|
-
|
|
18
|
-
<li><code>templates/</code> is a commonly-used directory in Obsidian projects, so it will be ignored
|
|
19
|
-
<li>A <code>settings.md</code> file will not generate a page. If you want a page called <code>settings</code>, you can create a <code>/settings/home.md</code> file.
|
|
20
|
-
<li><code>.cache.json</code>
|
|
21
|
-
<li><code>.output/</code>
|
|
22
|
-
<li><code>vercel.json</code>
|
|
23
|
-
</ul>
|
|
24
|
-
<p>Any files prefixed with a period will be ignored, as will any files that are not markdown.</main><aside><nav><ul><li><a href=index.html>Home</a><li><a href=/about.html>About</a><li><a href=/blog.html>Blog</a><ul><li><a href=/blog/url-ui.html>Long Live the URL</a></ul><li><a href=/docs.html>Docs</a><ul><li><a href=/docs/deploy.html>Deploy</a><li><a href=/docs/file-structure.html>Files</a><li><a href=/docs/folder-settings.html>Folders</a><li><a href=/docs/images.html>Images</a><li><a href=/docs/items.html>Items</a><li><a href=/docs/pages.html>Pages</a><li><a href=/docs/styling.html>Styling</a><li><a href=/docs/taxonomies.html>Taxonomies</a></ul><li><a href=/features.html>Features</a><ul><li><a href=/features/cards.html>Cards</a><li><a href=/features/editing.html>Live editing</a><li><a href=/features/emoji.html>Emoji favicons</a><li><a href=/features/frontmatter.html>Frontmatter</a><li><a href=/features/lists.html>Blog</a><li><a href=/features/navigation.html>Navigation</a><li><a href=/features/rich-previews.html>Rich link previews</a><li><a href=/features/robots.html>Robots</a><li><a href=/features/rss.html>RSS</a><li><a href=/features/sitemap.html>Sitemap</a><li><a href=/features/speed.html>Speed</a><li><a href=/features/static.html>Static generation</a><li><a href=/features/taxonomies.html>Taxonomies</a></ul><li><a href=/roadmap.html>Roadmap</a></ul></nav></aside><footer><section class=copyright>© 2026</section><section class=shoutout>Made with <a href=https://vowel.cc>Vowel</a></section></footer>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
<!doctypehtml><html lang=en><meta charset=UTF-8><meta name=viewport content="width=device-width, initial-scale=1.0"><meta http-equiv=X-UA-Compatible content=ie-edge><title>Folder settings - Documentation - Vowel</title><meta property=og:title content="Folder settings - Documentation - Vowel"><meta property=og:description content="Configure your project."><meta property=og:url content=/docs/folder-settings><link rel=stylesheet href=/default.css?y4rw9vtn><link rel=stylesheet href=/reset.css?6ev25jay><link rel=stylesheet href=/typography.css?lm3o88q7><meta property=og:site_name><body class=docs_folder-settings><header><a class=title href=/ rel=home>Vowel</a><p class=slogan>The easiest way to code a website<nav><a href=/about>About</a><a href=/blog>Blog</a><a href=/docs>Docs</a><a href=/features>Features</a><a href=/roadmap>Roadmap</a></nav><nav><a href=/docs/deploy>Deploy</a><a href=/docs/file-structure>Files</a><a href=/docs/folder-settings aria-current=page>Folders</a><a href=/docs/images>Images</a><a href=/docs/items>Items</a><a href=/docs/pages>Pages</a><a href=/docs/styling>Styling</a><a href=/docs/taxonomies>Taxonomies</a></nav></header><main><nav aria-label=Breadcrumbs><a href=/>Home</a><a href=/docs/>Docs</a><a href=/docs/folder-settings aria-current=page>Folders</a></nav><h1>Folder settings</h1><p itemprop=description>Configure your project.<nav aria-label=Contents><ol class="toc-level toc-level-1"></ol></nav><ul>
|
|
2
|
-
<li><code>breadcrumb</code>: A navigation label
|
|
3
|
-
</ul>
|
|
4
|
-
<p>At the root of the project, there should be a global settings file with the <code>breadcrumb</code> property and any of the following properties:
|
|
5
|
-
<ul>
|
|
6
|
-
<li>All folder settings, plus
|
|
7
|
-
<li><code>title</code>: Website title
|
|
8
|
-
<li><code>robots</code>
|
|
9
|
-
<ul>
|
|
10
|
-
<li><code>google</code>: Allow Google Search indexing (<code>true</code>/<code>false</code>)
|
|
11
|
-
<li><code>google_images</code>: Allow Google Image indexing (<code>true</code>/<code>false</code>)
|
|
12
|
-
<li><code>ai</code>: Allow AI training (<code>true</code>/<code>false</code>)
|
|
13
|
-
</ul>
|
|
14
|
-
|
|
15
|
-
<li><code>domain</code>: Full root URL for the website domain (e.g. <code>https://example.com</code>)
|
|
16
|
-
<li><code>author</code>: Website author credit for RSS and copyright
|
|
17
|
-
<li><code>icon</code>: An emoji to use as the site favicon
|
|
18
|
-
<li><code>slogan</code>: The website slogan
|
|
19
|
-
<li><code>logo</code>: The website logo
|
|
20
|
-
</ul></main><aside><nav><ul><li><a href=index.html>Home</a><li><a href=/about.html>About</a><li><a href=/blog.html>Blog</a><ul><li><a href=/blog/url-ui.html>Long Live the URL</a></ul><li><a href=/docs.html>Docs</a><ul><li><a href=/docs/deploy.html>Deploy</a><li><a href=/docs/file-structure.html>Files</a><li><a href=/docs/folder-settings.html>Folders</a><li><a href=/docs/images.html>Images</a><li><a href=/docs/items.html>Items</a><li><a href=/docs/pages.html>Pages</a><li><a href=/docs/styling.html>Styling</a><li><a href=/docs/taxonomies.html>Taxonomies</a></ul><li><a href=/features.html>Features</a><ul><li><a href=/features/cards.html>Cards</a><li><a href=/features/editing.html>Live editing</a><li><a href=/features/emoji.html>Emoji favicons</a><li><a href=/features/frontmatter.html>Frontmatter</a><li><a href=/features/lists.html>Blog</a><li><a href=/features/navigation.html>Navigation</a><li><a href=/features/rich-previews.html>Rich link previews</a><li><a href=/features/robots.html>Robots</a><li><a href=/features/rss.html>RSS</a><li><a href=/features/sitemap.html>Sitemap</a><li><a href=/features/speed.html>Speed</a><li><a href=/features/static.html>Static generation</a><li><a href=/features/taxonomies.html>Taxonomies</a></ul><li><a href=/roadmap.html>Roadmap</a></ul></nav></aside><footer><section class=copyright>© 2026</section><section class=shoutout>Made with <a href=https://vowel.cc>Vowel</a></section></footer>
|
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
<!doctypehtml><html lang=en><meta charset=UTF-8><meta name=viewport content="width=device-width, initial-scale=1.0"><meta http-equiv=X-UA-Compatible content=ie-edge><title>Images - Documentation - Vowel</title><meta property=og:title content="Images - Documentation - Vowel"><meta property=og:description content="How to host images."><meta property=og:url content=/docs/images><link rel=stylesheet href=/default.css?5sp5zfc3><link rel=stylesheet href=/reset.css?6t9x0yuz><link rel=stylesheet href=/typography.css?uelqd4ba><meta property=og:site_name><body class=docs_images><header><a class=title href=/ rel=home>Vowel</a><p class=slogan>The easiest way to code a website<nav><a href=/about>About</a><a href=/blog>Blog</a><a href=/docs>Docs</a><a href=/features>Features</a><a href=/roadmap>Roadmap</a></nav><nav><a href=/docs/deploy>Deploy</a><a href=/docs/file-structure>Files</a><a href=/docs/folder-settings>Folders</a><a href=/docs/images aria-current=page>Images</a><a href=/docs/items>Items</a><a href=/docs/pages>Pages</a><a href=/docs/styling>Styling</a><a href=/docs/taxonomies>Taxonomies</a></nav></header><main><nav aria-label=Breadcrumbs><a href=/>Home</a><a href=/docs/>Docs</a><a href=/docs/images aria-current=page>Images</a></nav><h1>Images</h1><p itemprop=description>How to host images.<nav aria-label=Contents><ol class="toc-level toc-level-1"></ol></nav><p>We recommend hosting images elsewhere.
|
|
2
|
-
<p>Images hosted on imgix will automatically be optimized, compressed, and formatted.</main><aside><nav><ul><li><a href=index.html>Home</a><li><a href=/about.html>About</a><li><a href=/blog.html>Blog</a><ul><li><a href=/blog/url-ui.html>Long Live the URL</a></ul><li><a href=/docs.html>Docs</a><ul><li><a href=/docs/deploy.html>Deploy</a><li><a href=/docs/file-structure.html>Files</a><li><a href=/docs/folder-settings.html>Folders</a><li><a href=/docs/images.html>Images</a><li><a href=/docs/items.html>Items</a><li><a href=/docs/pages.html>Pages</a><li><a href=/docs/styling.html>Styling</a><li><a href=/docs/taxonomies.html>Taxonomies</a></ul><li><a href=/features.html>Features</a><ul><li><a href=/features/cards.html>Cards</a><li><a href=/features/editing.html>Live editing</a><li><a href=/features/emoji.html>Emoji favicons</a><li><a href=/features/frontmatter.html>Frontmatter</a><li><a href=/features/lists.html>Blog</a><li><a href=/features/navigation.html>Navigation</a><li><a href=/features/rich-previews.html>Rich link previews</a><li><a href=/features/robots.html>Robots</a><li><a href=/features/rss.html>RSS</a><li><a href=/features/sitemap.html>Sitemap</a><li><a href=/features/speed.html>Speed</a><li><a href=/features/static.html>Static generation</a><li><a href=/features/taxonomies.html>Taxonomies</a></ul><li><a href=/roadmap.html>Roadmap</a></ul></nav></aside><footer><section class=copyright>© 2026</section><section class=shoutout>Made with <a href=https://vowel.cc>Vowel</a></section></footer>
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
<!doctypehtml><html lang=en><meta charset=UTF-8><meta name=viewport content="width=device-width, initial-scale=1.0"><meta http-equiv=X-UA-Compatible content=ie-edge><title>Items - Documentation - Vowel</title><meta property=og:title content="Items - Documentation - Vowel"><meta property=og:description content="With Vowel, you can create reusable pieces of content and embed them throughout your website."><meta property=og:url content=/docs/items><link rel=stylesheet href=/default.css?9q2j1ju1><link rel=stylesheet href=/reset.css?yi2buc58><link rel=stylesheet href=/typography.css?hq61zmuz><meta property=og:site_name><body class=docs_items><header><a class=title href=/ rel=home>Vowel</a><p class=slogan>The easiest way to code a website<nav><a href=/about>About</a><a href=/blog>Blog</a><a href=/docs>Docs</a><a href=/features>Features</a><a href=/roadmap>Roadmap</a></nav><nav><a href=/docs/deploy>Deploy</a><a href=/docs/file-structure>Files</a><a href=/docs/folder-settings>Folders</a><a href=/docs/images>Images</a><a href=/docs/items aria-current=page>Items</a><a href=/docs/pages>Pages</a><a href=/docs/styling>Styling</a><a href=/docs/taxonomies>Taxonomies</a></nav></header><main><nav aria-label=Breadcrumbs><a href=/>Home</a><a href=/docs/>Docs</a><a href=/docs/items aria-current=page>Items</a></nav><h1>Items</h1><p itemprop=description>With Vowel, you can create reusable pieces of content and embed them throughout your website.<nav aria-label=Contents><ol class="toc-level toc-level-1"></ol></nav><p>To create one, prefix a file or folder with a <code>$</code>, such as <code>$faqs</code>. The file or folder will not produce a page, but the content can be displayed on other pages, like so:
|
|
2
|
-
<pre><code class=language-md>Here are answers to common questions:
|
|
3
|
-
|
|
4
|
-
/faqs?count=10
|
|
5
|
-
</code></pre>
|
|
6
|
-
<p>This also allows richer content, as the item will be displayed with frontmatter.</main><aside><nav><ul><li><a href=index.html>Home</a><li><a href=/about.html>About</a><li><a href=/blog.html>Blog</a><ul><li><a href=/blog/url-ui.html>Long Live the URL</a></ul><li><a href=/docs.html>Docs</a><ul><li><a href=/docs/deploy.html>Deploy</a><li><a href=/docs/file-structure.html>Files</a><li><a href=/docs/folder-settings.html>Folders</a><li><a href=/docs/images.html>Images</a><li><a href=/docs/items.html>Items</a><li><a href=/docs/pages.html>Pages</a><li><a href=/docs/styling.html>Styling</a><li><a href=/docs/taxonomies.html>Taxonomies</a></ul><li><a href=/features.html>Features</a><ul><li><a href=/features/cards.html>Cards</a><li><a href=/features/editing.html>Live editing</a><li><a href=/features/emoji.html>Emoji favicons</a><li><a href=/features/frontmatter.html>Frontmatter</a><li><a href=/features/lists.html>Blog</a><li><a href=/features/navigation.html>Navigation</a><li><a href=/features/rich-previews.html>Rich link previews</a><li><a href=/features/robots.html>Robots</a><li><a href=/features/rss.html>RSS</a><li><a href=/features/sitemap.html>Sitemap</a><li><a href=/features/speed.html>Speed</a><li><a href=/features/static.html>Static generation</a><li><a href=/features/taxonomies.html>Taxonomies</a></ul><li><a href=/roadmap.html>Roadmap</a></ul></nav></aside><footer><section class=copyright>© 2026</section><section class=shoutout>Made with <a href=https://vowel.cc>Vowel</a></section></footer>
|