vowel 0.1.5 → 0.1.7
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/package.json +1 -1
- package/server.js +3 -2
- package/src/lib/components/DefaultStyles.svelte +60 -2
- package/src/lib/components/Markdown/validators.js +1 -1
- package/src/lib/components/Nav.svelte +7 -4
- package/src/lib/components/Page.svelte +1 -1
- package/src/lib/components/Sitemap.svelte +2 -2
- package/src/lib/utilities/createPageClass.js +1 -0
- package/src/lib/utilities/getPage.js +1 -0
- package/src/lib/utilities/getPagesByFolder.js +22 -20
- package/src/lib/utilities/processMarkdownFiles.js +11 -5
- package/src/routes/[...path]/+page.svelte +2 -2
- package/vite.config.js +2 -1
- package/content/.cache.json +0 -627
- package/content/.obsidian/app.json +0 -3
- package/content/.obsidian/appearance.json +0 -3
- package/content/.obsidian/core-plugins-migration.json +0 -30
- package/content/.obsidian/core-plugins.json +0 -20
- package/content/.obsidian/workspace.json +0 -168
- package/content/about.md +0 -3
- package/content/assets/open-props.css +0 -1630
- package/content/assets/styles-2.css +0 -128
- package/content/assets/styles-3.css +0 -275
- package/content/docs/file-structure.md +0 -31
- package/content/docs/folder-settings.md +0 -22
- package/content/docs/home.md +0 -8
- package/content/docs/images.md +0 -10
- package/content/docs/pages.md +0 -64
- package/content/docs/quickstart.md +0 -52
- package/content/docs/run-build-deploy.md +0 -20
- package/content/docs/settings.md +0 -4
- package/content/docs/styling.md +0 -10
- package/content/docs/taxonomies.md +0 -37
- package/content/home.md +0 -75
- package/content/roadmap.md +0 -84
- package/content/settings.md +0 -12
package/content/home.md
DELETED
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
# Home
|
|
2
|
-
|
|
3
|
-
Vowel is a very simple Markdown- and CSS-based website generator.
|
|
4
|
-
|
|
5
|
-
To try it out, `cd` into a directory of markdown files and run:
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
npx -p svelte@next -p vowel@latest npx vowel
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
(This `npx` command forces the Svelte 5 peer depedency, without which the app will throw an error.)
|
|
12
|
-
|
|
13
|
-
 Here's a photo
|
|
14
|
-
|
|
15
|
-
Vowel is a minimal website framework for developers who love to write CSS and read RSS.
|
|
16
|
-
|
|
17
|
-
> Here's a lovely block quote.
|
|
18
|
-
|
|
19
|
-
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.
|
|
20
|
-
|
|
21
|
-
See a [demo on StackBlitz](https://stackblitz.com/edit/stackblitz-starters-nh7m7v?file=home.md). (**Error:** This demo might not work due conflicts in Svelte 5's peer dependencies.)
|
|
22
|
-
|
|
23
|
-
Vowel is created by Sam Littlefair. If you have questions or comments, [reach out to me on Twitter](https://twitter.com/samlfair).
|
|
24
|
-
|
|
25
|
-
**Warning!** This project is still in early development. There are many bugs and the API is changing quickly.
|
|
26
|
-
|
|
27
|
-
# Features
|
|
28
|
-
|
|
29
|
-
## Sitemap 🗺️
|
|
30
|
-
|
|
31
|
-
Submit your website to search engines with a sitemap that lists all of your pages.
|
|
32
|
-
|
|
33
|
-
## RSS 📡
|
|
34
|
-
|
|
35
|
-
Deliver your content to RSS readers with an Atom feed that lists your full posts in reverse-chronology.
|
|
36
|
-
|
|
37
|
-
## Speed ⚡️
|
|
38
|
-
|
|
39
|
-
Get a blazing-fast, Svelte-rendered website.
|
|
40
|
-
|
|
41
|
-
## Static generation 🗿
|
|
42
|
-
|
|
43
|
-
Load pages quickly with plain HTML.
|
|
44
|
-
|
|
45
|
-
## Copyright 🔒
|
|
46
|
-
|
|
47
|
-
Display an up-to-date copyright in the footer of your website.
|
|
48
|
-
|
|
49
|
-
## Rich link previews 🔗
|
|
50
|
-
|
|
51
|
-
Create rich links with titles and images, both internally and externally.
|
|
52
|
-
|
|
53
|
-
## Navigation 🚏
|
|
54
|
-
|
|
55
|
-
Structure your content with a header, nav, sitemap, and breadcrumbs.
|
|
56
|
-
|
|
57
|
-
## Emoji favicon 🙃
|
|
58
|
-
|
|
59
|
-
Use any emoji you want for your website's icon.
|
|
60
|
-
|
|
61
|
-
## Custom taxonomies 🖇️
|
|
62
|
-
|
|
63
|
-
Go beyond tags to create authors and categories.
|
|
64
|
-
|
|
65
|
-
## Advanced frontmatter 🧮
|
|
66
|
-
|
|
67
|
-
Display dates, lists, nested properties, links, and images in your frontmatter.
|
|
68
|
-
|
|
69
|
-
## Live editing 👩🎤
|
|
70
|
-
|
|
71
|
-
See updates live as you save.
|
|
72
|
-
|
|
73
|
-
# Try it
|
|
74
|
-
|
|
75
|
-
/docs/quickstart
|
package/content/roadmap.md
DELETED
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: What's planned.
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# Roadmap
|
|
6
|
-
|
|
7
|
-
## MVP
|
|
8
|
-
|
|
9
|
-
- [x] Add all element types supported in Obsidian to markdown
|
|
10
|
-
- [x] Add rich link previews
|
|
11
|
-
- [x] Add RSS
|
|
12
|
-
- [x] Add robots.txt
|
|
13
|
-
- [x] AI
|
|
14
|
-
- [x] Search
|
|
15
|
-
- [x] Image
|
|
16
|
-
- [x] Typing
|
|
17
|
-
- [x] Add sitemap
|
|
18
|
-
- [x] Make taxonomies linkable in frontmatter (if a corresponding folder exists)
|
|
19
|
-
- [x] Add header metadata (meta tags)
|
|
20
|
-
- [x] CSS handling
|
|
21
|
-
- [x] Favicon handling
|
|
22
|
-
- [x] Docs
|
|
23
|
-
- [x] Build action
|
|
24
|
-
|
|
25
|
-
## V2
|
|
26
|
-
|
|
27
|
-
- [ ] Tables of contents
|
|
28
|
-
- [/] CSS defaults (work in progress)
|
|
29
|
-
- [ ] Fallback homepages
|
|
30
|
-
- [ ] Init CLI
|
|
31
|
-
- [ ] Better default styles
|
|
32
|
-
- [ ] CSS layout [presets](https://github.com/swyxio/spark-joy?tab=readme-ov-file#drop-in-css-frameworks)
|
|
33
|
-
- [ ] Post list element (`#tags/blue`, `@tags/blue`, `~tags/blue`)
|
|
34
|
-
- [x] Images as <figure>s
|
|
35
|
-
- [x] Frontmatter interpolation (title and description)
|
|
36
|
-
- [ ] Frontmatter interpolation (image)
|
|
37
|
-
- [x] Better favicon and styles handling
|
|
38
|
-
- [x] Ignore README files
|
|
39
|
-
- [ ] Add more header metadata
|
|
40
|
-
- [ ] Define folder settings
|
|
41
|
-
- [ ] Title
|
|
42
|
-
- [ ] Breadrumb
|
|
43
|
-
- [x] Define special page properties
|
|
44
|
-
- [x] Title
|
|
45
|
-
- [x] Description
|
|
46
|
-
- [x] Meta image
|
|
47
|
-
- [x] Date
|
|
48
|
-
- [ ] Modified date
|
|
49
|
-
- [ ] Tags
|
|
50
|
-
- [ ] Author/Authors
|
|
51
|
-
- [ ] Make file names kebab-cased for URLs and links
|
|
52
|
-
- [x] Include breadcrumbs in page titles ~~(optionally)~~
|
|
53
|
-
- [ ] Strikethrough
|
|
54
|
-
- [ ] Add hidden routes (`$`)
|
|
55
|
-
- [x] Image alt text
|
|
56
|
-
- [ ] Code highlighter
|
|
57
|
-
- [x] Deploy action (Vercel)
|
|
58
|
-
- [x] Add anchor links for headings
|
|
59
|
-
- [ ] Post TOC
|
|
60
|
-
- [ ] GitHub-style notes
|
|
61
|
-
- [ ] Add in-browser search
|
|
62
|
-
- [x] Figure out how to stop components from remounting on every change
|
|
63
|
-
- [ ] Make RSS optional
|
|
64
|
-
- [ ] Pagination
|
|
65
|
-
- [x] Demote headings global option (headings are now demoted intelligently)
|
|
66
|
-
|
|
67
|
-
## Wish list
|
|
68
|
-
|
|
69
|
-
- [ ] Automatic file creation
|
|
70
|
-
- [ ] Image serving and optimization
|
|
71
|
-
- [ ] GUI
|
|
72
|
-
- [ ] More deploy actions
|
|
73
|
-
- [ ] Optional JSON interactivity (ratings, comments, SubPubHub)
|
|
74
|
-
- [ ] Redirects
|
|
75
|
-
- [ ] Advanced markdown
|
|
76
|
-
- [ ] Highlight
|
|
77
|
-
- [ ] Sanitize
|
|
78
|
-
- [ ] Tables
|
|
79
|
-
- [ ] Strike
|
|
80
|
-
- [ ] Task lists
|
|
81
|
-
- [ ] Footnotes
|
|
82
|
-
- [ ] Mermaid
|
|
83
|
-
- [ ] Math
|
|
84
|
-
- [ ] Wikilinks
|