vowel 0.6.4 → 0.7.0-beta.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,73 +0,0 @@
----
-name: Bug report
-about: Report a bug to help improve Vowel.
-title: ""
-labels: "bug"
-assignees: "samlfair"
----
-
-<!--
-  Thanks for taking the time to help build Vowel.
-  A well-detailed bug report helps us to solve the problem quickly.
--->
-
-### Versions
-
-- vowel: <!-- eg: v0.1.32 -->
-- node: <!-- eg: v14.15.0 -->
-- os: <!-- eg: macOS 14.5 -->
-- browser: <!-- eg: Chrome 129 -->
-
-### Browser report
-
-<!--
-  Generate a browser report at https://www.whatsmybrowser.org/
-  Copy-paste a link to the report
--->
-
-### Link to Stackblitz
-
-<!--
-  If possible, upload a reproduction to Stackblitz
-  and copy-paste the link here
--->
-
-### Steps to reproduce
-
-<!-- eg: "Go to X and click on Y" -->
-
-### Expected behavior
-
-<!-- eg: "The image will appear below the headline" -->
-
-### Actual behavior
-
-<!-- eg: "The image appears above the headline" -->
-
-### Additional technologies
-
-<!-- List any other technologies you're using with Vowel -->
-
-### Screenshot
-
-<!-- If possible, include a screenshot of the issue -->
-
-### Errors from terminal
-
-<!-- If there are any error messages in the terminal, paste them here -->
-
-```
-
-```
-
-### Errors from browser console
-
-<!-- If there are any error message in the error console, paste them here -->
-
-```
-
-```
-
-### Additional comments
-
-<!-- Include any other relevent information -->

package/.github/ISSUE_TEMPLATE/config.yml

@@ -1,7 +0,0 @@
-contact_links:
-  - name: Vowel on Twitter
-    url: https://twitter.com/tryvowel
-    about: Get in touch with questions or ideas.
-  - name: Sam on Twitter
-    url: https://twitter.com/samlfair
-    about: Get in touch to chat.

package/docs-source/.cache.json

@@ -1,9 +0,0 @@
-{
-  "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

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

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

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

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

@@ -1,30 +0,0 @@
-{
-  "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

@@ -1,20 +0,0 @@
-[
-  "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

@@ -1,168 +0,0 @@
-{
-  "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

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

package/docs-source/about.md

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

package/docs-source/blog/home.md

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

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

@@ -1,21 +0,0 @@
----
-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.

package/docs-source/blog.md

@@ -1,5 +0,0 @@
-# Blog
-
-Here's a blog.
-
-/blog/**

package/docs-source/docs/deploy.md

@@ -1,67 +0,0 @@
----
-title: Deploy
-description: Get going.
----
-
-See the [quickstart](/docs/quickstart) for instructions on how to use npm.
-
-**Note on URLs:** This guide includes instructions for Vercel, which specify a deploy option called `cleanUrls`. This will trim the `.html` extension from your deployment URLs. If you configure your own deploy, ensure you use clean URLs or your links will not work.
-
-# GitHub
-
-If you have a GitHub repository of Markdown files, you can deploy them on Vercel automatically on changes.
-
-Add a `vercel.json` file to the root of your project with the following contents:
-
-```js
-{
-  "cleanUrls": true,
-  "outputDirectory": ".output",
-  "buildCommand": "npx -p svelte@next -p vowel@latest npx vowel build"
-}
-```
-
-Then create a new Vercel project and connect your GitHub repository.
-
-When you push changes to your repository, your Vercel project will automatically rebuild.
-
-# npx
-
-You can manually build your project with `npx`. Run this command:
-
-```
-npx -y -p svelte@next -p vowel@latest npx vowel build
-```
-
-The build command will create a `vercel.json` file at the root of your project with the necessary configuration for a Vercel deploy. Now deploy to Vercel:
-
-```
-npx vercel --prod
-```
-
-(The `--prod` flag will deploy to production.)
-
-If you don't want to use the Vercel CLI, you can deploy the `.output` directory to any server that supports static HTML.
-
-# npm
-
-If you set up your project with npm, you can include a `build` command in your `package.json`:
-
-```diff
-    "scripts": {
-      "dev": "vowel",
-+     "build": "vowel build"
-    },
-```
-
-Run `npm run build` (`vowel build`) to build your website.
-
-Now you can deploy to Vercel:
-
-```
-npx vercel --prod
-```
-
-(The `--prod` flag will deploy to production.)
-
-If you don't want to use the Vercel CLI, you can deploy the `.output` directory to any server that supports static HTML.

package/docs-source/docs/file-structure.md

@@ -1,31 +0,0 @@
----
-title: File structure
-breadcrumb: Files
-description: Organize your files.
----
-
-Your website is made of folders and markdown files. Every folder should have a `home.md` file. Every folder can also have a `settings.md` file to apply folder-level settings, such as the `breadcrumb`.
-
-Almost every file and folder represents a page on your website:
-
-- `home.md` is your homepage, `/`
-- `about.md` would be your about page, `/about`
-- `blog/home.md` would be your blog homepage, `/blog`
-- `blog/hello-world.md` would be a blog post, `/blog/hello-world`
-
-(File names like `Hello World.md` also seem to work fine so far.))
-
-Even if a folder doesn't have a `home.md` file, it will still generate a page, so long as it contains any markdown files. So, if you have a `blog` folder with posts inside it, Vowel will generate a `/blog` homepage even if you don't have a `/blog/home.md` file.
-
-There are a few special files and folders:
-
-- `assets/` contains some static files
-  - `assets/styles.css` contains your stylesheet, which will be automatically applied if present
-  - `assets/favicon.png` is your favicon
-- `templates/` is a commonly-used directory in Obsidian projects, so it will be ignored
-- A `settings.md` file will not generate a page. If you want a page called `settings`, you can create a `/settings/home.md` file.
-- `.cache.json`
-- `.output/`
-- `vercel.json`
-
-Any files prefixed with a period will be ignored, as will any files that are not markdown.

package/docs-source/docs/folder-settings.md

@@ -1,23 +0,0 @@
----
-title: Folder settings
-breadcrumb: Folders
-description: Configure your project.
----
-
-Every folder should have a `settings.md` file with one property:
-
-- `breadcrumb`: A navigation label
-
-At the root of the project, there should be a global settings file with the `breadcrumb` property and any of the following properties:
-
-- All folder settings, plus
-- `title`: Website title
-- `robots`
-  - `google`: Allow Google Search indexing (`true`/`false`)
-  - `google_images`: Allow Google Image indexing (`true`/`false`)
-  - `ai`: Allow AI training (`true`/`false`)
-- `domain`: Full root URL for the website domain (e.g. `https://example.com`)
-- `author`: Website author credit for RSS and copyright
-- `icon`: An emoji to use as the site favicon
-- `slogan`: The website slogan
-- `logo`: The website logo

package/docs-source/docs/home.md

@@ -1,55 +0,0 @@
----
-title: Documentation
-description: Learn how to use Vowel.
----
-
-Let's get started.
-
-
-## npx
-
-npx is the easiest way to use vowel:
-
-```
-npx -y -p svelte@next -p vowel@latest npx vowel
-```
-
-Vowel will attempt to generate a website based on the contents of your file.
-
-## npm
-
-Create a directory. Then, open that directory and run these commands in your terminal:
-
-```bash
-npm init --y && npm i vowel svelte@next
-```
-
-Edit your `package.json` to add these `scripts`:
-
-```json
-{
-	"dev": "vowel",
-	"build": "vowel build"
-}
-```
-
-Now run `npm run dev`.
-
-## Starter files
-
-Create `home.md` and enter some basic information
-
-```md
-# Your website
-
-Lorem ipsum...
-```
-
-Create `settings.md` and enter some basic information in the frontmatter:
-
-```
----
-breadcrumb: Home
-domain: https://example.com
----
-```

package/docs-source/docs/images.md

@@ -1,10 +0,0 @@
----
-title: Images
-description: How to host images.
----
-
-You can put images in the `assets` folder, but this is discouraged, as it could result in a large bandwidth bill from your hosting provider.
-
-We recommend hosting images elsewhere.
-
-Images hosted on imgix will automatically be optimized, compressed, and formatted.

package/docs-source/docs/items.md

@@ -1,13 +0,0 @@
-# Items
-
-With Vowel, you can create reusable pieces of content and embed them throughout your website.
-
-To create one, prefix a file or folder with a `$`, such as `$faqs`. The file or folder will not produce a page, but the content can be displayed on other pages, like so:
-
-```md
-Here are answers to common questions:
-
-/$faqs?count=10
-```
-
-This also allows richer content, as the item will be displayed with frontmatter.