vowel 0.1.46 → 0.2.2

package/README.md

@@ -1,29 +1,91 @@
 # Vowel
 
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
+*Markdown websites in milliseconds*
 
-Vowel is the easiest way to code your own website.
+## Roadmap
 
-[Try it on StackBlitz](https://stackblitz.com/~/github.com/samlfair/vowel-site?file=home.md).
+### High priority
 
-Turn a folder of Markdown files into a website by running one command:
+- [ ] robots.txt
+- [ ] sitemap.xml
+- [ ] 404.html
+- [ ] TUI
+  - [ ] Create settings.md
+    - [ ] Site title
+    - [ ] Domain
+    - [ ] Webmentions
+    - [ ] Logo
+    - [ ] Wordmark
+    - [ ] Identity (rel=me)
+    - [ ] Filename breadcrumbs
+    - [ ] RSS
+    - [ ] Sitemap
+  - [ ] Create home.md
+  - [ ] Create folder settings files
+    - [ ] Title
+    - [ ] Breadcrumb
+- [ ] Custom CSS
+- [ ] Tags
+- [ ] Customize index fallback
+- [ ] Date format settings
+- [ ] ::mark::
+- [ ] Infer images
+- [ ] Favicon
+- [ ] Webmentions
+- [ ] HTML boilerplate
+- [ ] Page lists
+- [ ] View transitions
+- [ ] Logo
+- [ ] Wordmark
+- [ ] Sort nav items
+- [ ] Canonical URL
+- [ ] Handle external links
+- [ ] Admonitions
+- [ ] Use hgroup for site title, page title, etc
+- [ ] Images as `<figure>`
+- [ ] Hidden routes
+- [ ] Frontmatter settings
+  - [ ] HTML
+  - [ ] RSS
+  - [ ] Sitemap
+- [ ] Heading anchors
+- [ ] Taxonomy pages and smart frontmatter
+- [ ] CSS cache busting
+- [ ] Slogan in homepage title
 
-```
-npx vowel
-```
+### Medium priority
 
-Create a blog, a documentation site, a landing page, a wiki (whatever you want), using just Markdown and CSS.
+- [ ] Tests
+- [ ] Break code into multiple files
+- [ ] Image optimization (unpic)
+- [ ] [SVG by mask](https://pqina.nl/blog/set-svg-background-image-fill-color/) and [CSS icons](https://antfu.me/posts/icons-in-pure-css)
+- [ ] WYSIWYG editor
+- [ ] Better signals
+  - [ ] File-written callback
+- [ ] Themes
+- [ ] Deploy
+  - [ ] Cloudflare pages
+  - [ ] GitHub pages
+- [ ] Post-publish work (ping webmentions)
+- [ ] [Desktop app](https://blackboard.sh/electrobun/docs/)
+- [ ] Mermaid
+- [ ] Codeblock syntax highlighting
+- [ ] Extraction utilities (regex in archive)
+- [ ] Smarter frontmatter
+  - [ ] Object dl
+  - [ ] Array ul
+  - [ ] Image
+  - [ ] URL
+  - [ ] Date
+- [ ] TOC
+- [ ] Versioning/publishing script
+- [ ] Verify all element types form Obsidian
 
-No HTML.
+### Low priority
 
-No JavaScript.
-
-[Read the docs](https://vowel.cc/docs).
-
-For comments, questions, bugs, and contributions, please reach out to me on Twitter: [@samlfair](https://twitter.com/samlfair).
-
-[npm-version-src]: https://img.shields.io/npm/v/vowel/latest.svg
-[npm-version-href]: https://npmjs.com/package/vowel
-[npm-downloads-src]: https://img.shields.io/npm/dm/vowel.svg
-[npm-downloads-href]: https://npmjs.com/package/vowel
+- [ ] Footnotes
+- [ ] Frontmatter taxonomies
+- [ ] Recursive frontmatter
+- [ ] Browser search
+- [ ] Pagination
+- [ ] ATProto

package/bin.js

@@ -1,81 +1,5 @@
 #!/usr/bin/env node
 
-import { execSync, spawn } from 'child_process';
-import path from 'node:path';
-import url from 'node:url';
-import pc from 'picocolors';
-import mri from 'mri';
-import filterConsole from 'filter-console';
-import process from 'process';
-import readline from 'readline';
-import logUpdate from 'log-update';
+import init from "./index.js"
 
-const args = mri(process.argv);
-
-// Directory where the module is
-const binURL = import.meta.url;
-const binFilePath = url.fileURLToPath(binURL);
-const binDirName = path.dirname(binFilePath);
-
-// Directory where the command was called
-const homeDir = process.cwd();
-
-const spawnArgs = ['./server.js', '--directory', homeDir];
-if (args._.includes('build')) spawnArgs.push('--build');
-if (args._.includes('publish')) {
-	spawnArgs.push('--build')
-	spawnArgs.push('--publish')
-};
-
-if (!args.verbose) {
-	// filterConsole(['jsconfig', 'vite', 'Vite', 'tsconfig', `--host`]);
-	console.log(`\n\n`);
-}
-
-// Args: File to run, home directory,
-const child = spawn('node', spawnArgs, {
-	cwd: binDirName
-});
-
-let processedFiles = 0;
-let foundFiles = 0;
-const std = process.stdout;
-
-child.stdout.on('data', (data) => {
-	const message = data.toString();
-	if (message.match('fileread')) {
-		processedFiles++;
-		logUpdate(pc.green(`    Files read: ${processedFiles}/${foundFiles}`));
-	} else if (message.startsWith('filesfound')) {
-		const count = Number(message.split(':').at(-1).slice(0, -1));
-		foundFiles += count;
-	} else if (message.startsWith('loaded')) {
-		logUpdate(pc.green(`    Files read: ${foundFiles}/${foundFiles}`));
-		console.log(`\n\n`);
-		processedFiles = 0;
-		foundFiles = 0;
-	} else if(true) { // Toggle to true to reveal all console output
-		console.log(message)
-	} else if (message.match('http://localhost:')) {
-		const url = message.match(/http:\/\/localhost:\S+/);
-		console.log(
-			pc.bgCyan(
-				pc.bold(`
-
-    Website: ${url}
-`)
-			)
-		);
-		console.log(`\n`);
-	} else {
-		console.log(pc.blue(data));
-	}
-});
-
-child.stderr.on('data', (data) => {
-	console.error(pc.red(data));
-});
-
-child.on('close', (code) => {
-	console.log(`child process exited with code ${code}`);
-});
+await init()

package/docs-source/$features/cards.md

@@ -0,0 +1,7 @@
+---
+icon: 🃏
+---
+
+# Cards
+
+Create eye-catching content with no fuss. (Like this.)

package/docs-source/$features/editing.md

@@ -0,0 +1,7 @@
+---
+icon: 👩‍🎤
+---
+
+# Live editing
+
+See updates live as you save.

package/docs-source/$features/emoji.md

@@ -0,0 +1,7 @@
+---
+icon: 🙃
+---
+
+# Emoji favicons
+
+Use any emoji you want for your website's icon.

package/docs-source/$features/frontmatter.md

@@ -0,0 +1,7 @@
+---
+icon: 🧮
+---
+
+# Frontmatter
+
+Display dates, lists, nested properties, links, and images in your frontmatter.

package/docs-source/$features/lists.md

@@ -0,0 +1,7 @@
+---
+icon: 🍱
+---
+
+# Blog
+
+Write one line to list your blog posts.

package/docs-source/$features/navigation.md

@@ -0,0 +1,7 @@
+---
+icon: 🚏
+---
+
+# Navigation
+
+Structure your content with smart nav menus.

package/docs-source/$features/rich-previews.md

@@ -0,0 +1,7 @@
+---
+icon: 🤿
+---
+
+# Rich link previews
+
+Create rich links with titles and images.

package/docs-source/$features/robots.md

@@ -0,0 +1,7 @@
+---
+icon: 🤖
+---
+
+# Robots
+
+Take control of your robots.txt.

package/docs-source/$features/rss.md

@@ -0,0 +1,7 @@
+---
+icon: 📡
+---
+
+# RSS
+
+Deliver your content to RSS readers with an Atom feed.

package/docs-source/$features/sitemap.md

@@ -0,0 +1,7 @@
+---
+icon: 🗺️
+---
+
+# Sitemap
+
+Submit your website to search engines with a sitemap that lists all of your pages.

package/docs-source/$features/speed.md

@@ -0,0 +1,7 @@
+---
+icon: 🏎️
+---
+
+# Speed
+
+Get a blazing-fast, Svelte-rendered website.

package/docs-source/$features/static.md

@@ -0,0 +1,7 @@
+---
+icon: 🏛️
+---
+
+# Static generation
+
+Load pages quickly with plain HTML.

package/docs-source/$features/taxonomies.md

@@ -0,0 +1,7 @@
+---
+icon: 🔖
+---
+
+# Taxonomies
+
+Go beyond tags to create authors and categories.

package/docs-source/.cache.json

@@ -0,0 +1,9 @@
+{
+  "https://www.nngroup.com/articles/url-as-ui/": {
+    "url": "https://www.nngroup.com/articles/url-as-ui/",
+    "canonical": "https://www.nngroup.com/articles/url-as-ui/",
+    "title": "URL as UI",
+    "image": "",
+    "description": "Users continue to type and guess URLs and domain names, so Web usability can be improved by better URLs. In the long term this machine-level addressing scheme must be hidden."
+  }
+}

package/docs-source/.obsidian/app.json

@@ -0,0 +1,3 @@
+{
+  "promptDelete": false
+}

package/docs-source/.obsidian/appearance.json

@@ -0,0 +1,3 @@
+{
+  "accentColor": ""
+}

package/docs-source/.obsidian/core-plugins-migration.json

@@ -0,0 +1,30 @@
+{
+  "file-explorer": true,
+  "global-search": true,
+  "switcher": true,
+  "graph": true,
+  "backlink": true,
+  "canvas": true,
+  "outgoing-link": true,
+  "tag-pane": true,
+  "properties": false,
+  "page-preview": true,
+  "daily-notes": true,
+  "templates": true,
+  "note-composer": true,
+  "command-palette": true,
+  "slash-command": false,
+  "editor-status": true,
+  "bookmarks": true,
+  "markdown-importer": false,
+  "zk-prefixer": false,
+  "random-note": false,
+  "outline": true,
+  "word-count": true,
+  "slides": false,
+  "audio-recorder": false,
+  "workspaces": false,
+  "file-recovery": true,
+  "publish": false,
+  "sync": false
+}

package/docs-source/.obsidian/core-plugins.json

@@ -0,0 +1,20 @@
+[
+  "file-explorer",
+  "global-search",
+  "switcher",
+  "graph",
+  "backlink",
+  "canvas",
+  "outgoing-link",
+  "tag-pane",
+  "page-preview",
+  "daily-notes",
+  "templates",
+  "note-composer",
+  "command-palette",
+  "editor-status",
+  "bookmarks",
+  "outline",
+  "word-count",
+  "file-recovery"
+]

package/docs-source/.obsidian/workspace.json

@@ -0,0 +1,168 @@
+{
+  "main": {
+    "id": "966664a33c0f9428",
+    "type": "split",
+    "children": [
+      {
+        "id": "6f272e6d83175a0e",
+        "type": "tabs",
+        "children": [
+          {
+            "id": "6d5fa6e59ac0d3e8",
+            "type": "leaf",
+            "state": {
+              "type": "markdown",
+              "state": {
+                "file": "home.md",
+                "mode": "source",
+                "source": false
+              }
+            }
+          }
+        ]
+      }
+    ],
+    "direction": "vertical"
+  },
+  "left": {
+    "id": "18e0bc63ac82562e",
+    "type": "split",
+    "children": [
+      {
+        "id": "9cc6c8640bf83790",
+        "type": "tabs",
+        "children": [
+          {
+            "id": "08551dcebb684ee5",
+            "type": "leaf",
+            "state": {
+              "type": "file-explorer",
+              "state": {
+                "sortOrder": "alphabetical"
+              }
+            }
+          },
+          {
+            "id": "39b7b22b2e81f451",
+            "type": "leaf",
+            "state": {
+              "type": "search",
+              "state": {
+                "query": "",
+                "matchingCase": false,
+                "explainSearch": false,
+                "collapseAll": false,
+                "extraContext": false,
+                "sortOrder": "alphabetical"
+              }
+            }
+          },
+          {
+            "id": "48ac4934e3c350a8",
+            "type": "leaf",
+            "state": {
+              "type": "bookmarks",
+              "state": {}
+            }
+          }
+        ]
+      }
+    ],
+    "direction": "horizontal",
+    "width": 300
+  },
+  "right": {
+    "id": "c120d9bbbfa46883",
+    "type": "split",
+    "children": [
+      {
+        "id": "d7378259eead963a",
+        "type": "tabs",
+        "children": [
+          {
+            "id": "3c5acbb57e9b2ecc",
+            "type": "leaf",
+            "state": {
+              "type": "backlink",
+              "state": {
+                "file": "home.md",
+                "collapseAll": false,
+                "extraContext": false,
+                "sortOrder": "alphabetical",
+                "showSearch": false,
+                "searchQuery": "",
+                "backlinkCollapsed": false,
+                "unlinkedCollapsed": true
+              }
+            }
+          },
+          {
+            "id": "dbc00eb5b912c400",
+            "type": "leaf",
+            "state": {
+              "type": "outgoing-link",
+              "state": {
+                "file": "home.md",
+                "linksCollapsed": false,
+                "unlinkedCollapsed": true
+              }
+            }
+          },
+          {
+            "id": "192b432a0da5e507",
+            "type": "leaf",
+            "state": {
+              "type": "tag",
+              "state": {
+                "sortOrder": "frequency",
+                "useHierarchy": true
+              }
+            }
+          },
+          {
+            "id": "7d5f5d40b932706c",
+            "type": "leaf",
+            "state": {
+              "type": "outline",
+              "state": {
+                "file": "home.md"
+              }
+            }
+          }
+        ]
+      }
+    ],
+    "direction": "horizontal",
+    "width": 300,
+    "collapsed": true
+  },
+  "left-ribbon": {
+    "hiddenItems": {
+      "switcher:Open quick switcher": false,
+      "graph:Open graph view": false,
+      "canvas:Create new canvas": false,
+      "daily-notes:Open today's daily note": false,
+      "templates:Insert template": false,
+      "command-palette:Open command palette": false
+    }
+  },
+  "active": "6d5fa6e59ac0d3e8",
+  "lastOpenFiles": [
+    "clouds.jpg",
+    "home.md",
+    "blog/travel/home.md",
+    "blog/hello-world.md",
+    "blog/cooking/home.md",
+    "blog/economics/home.md",
+    "blog/economics/smith.md",
+    "blog/economics/keynes.md",
+    "blog/home.md",
+    "blog/cooking/soup.md",
+    "blog/cooking/settings.md",
+    "blog/cooking/pancakes.md",
+    "blog/economics",
+    "blog/Untitled.md",
+    "about.md",
+    "settings.md"
+  ]
+}

package/docs-source/.stackblitzrc

@@ -0,0 +1,3 @@
+{
+    "startCommand": "npx -y -p svelte@next -p vowel@latest npx vowel"
+}

package/docs-source/.vercel/README.txt

@@ -0,0 +1,11 @@
+> Why do I have a folder named ".vercel" in my project?
+The ".vercel" folder is created when you link a directory to a Vercel project.
+
+> What does the "project.json" file contain?
+The "project.json" file contains:
+- The ID of the Vercel project that you linked ("projectId")
+- The ID of the user or team your Vercel project is owned by ("orgId")
+
+> Should I commit the ".vercel" folder?
+No, you should not share the ".vercel" folder with anyone.
+Upon creation, it will be automatically added to your ".gitignore" file.

package/docs-source/.vercel/project.json

@@ -0,0 +1 @@
+{"projectId":"prj_4CUiAmqACnAFX1cjGqW5om7DbK4E","orgId":"team_CpFUbX79Msg6m5IOy2BzFxEE"}

package/docs-source/about.md

@@ -0,0 +1,3 @@
+# About
+
+This is an about page.

package/docs-source/assets/styles.css

@@ -0,0 +1,51 @@
+.link-preview {
+  h2 {
+    margin-top: 0;
+  }
+}
+
+.folder-blog {
+  margin-block: var(--size-9);
+
+  & > article + article {
+    border-top: 1px solid var(--surface-3);
+  }
+
+  & > article > .content,
+  & > article > :not(h1, time) {
+    display: none;
+  }
+
+  & > article {
+    display: flex;
+    flex-direction: row;
+    justify-content: space-between;
+    gap: 1rem;
+    align-items: baseline;
+    padding-inline: 0;
+    background: unset;
+    border-radius: 0;
+    border: unset;
+  }
+
+  & article + article {
+    border-top: 1px solid grey;
+  }
+
+  & > article > h1 {
+    max-inline-size: unset;
+    font-weight: 600;
+    flex: 1;
+    font-size: 1em;
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    gap: 1rem;
+  }
+
+  & > article > time {
+    margin-left: auto;
+    margin: 0;
+    font-size: 1em;
+  }
+}

package/docs-source/blog/home.md

@@ -0,0 +1,5 @@
+# Blog
+
+Here's a blog.
+
+/blog?count=100&content=false

package/docs-source/blog/url-ui.md

@@ -0,0 +1,21 @@
+---
+link: https://www.nngroup.com/articles/url-as-ui/
+breadcrumb: URL Design
+---
+
+June 27, 2024
+
+![some things](./dog.jpeg)
+
+# Long Live the URL
+
+This article from 1999 about how to write good URLs is awesome. Some tips:
+
+- Write in lowercase
+- Check for typos
+- URLs should be permanent
+- Keep URLs short
+
+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.
+
+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.