vowel 0.0.2 → 0.1.0

package/src/routes/[...path]/+page.svelte

@@ -0,0 +1,125 @@
+<script>
+	import { Nav, Page, Breadcrumbs, Sitemap, DefaultStyles } from '$lib/components/index.js';
+	import { getPage, createPageClass } from '$lib/utilities/index.js';
+	import LinkPreview from '$lib/components/Markdown/LinkPreview.svelte';
+	import getFileLabel from '../../lib/utilities/getFileLabel';
+	import { error } from '@sveltejs/kit';
+	import { getFolder, getFolderLabel } from '../../lib/utilities';
+	import { page as pageStore } from '$app/stores';
+	import { dev, building } from '$app/environment';
+
+	let { data } = $props();
+
+	const { website, folderName } = $derived(data);
+	const { slogan } = website;
+
+	if (data.files.css.exists && dev) {
+		// Import styles in dev mode
+		import(/* @vite-ignore */ data.files.css.path);
+	}
+
+	const page = $derived(getPage(website, data.path));
+
+	if (!page) {
+		error(404, 'Page not found');
+	}
+
+	const websiteTitle = data.website._.title || data.folderName;
+	const pageMetaTitle = $derived(getFileLabel(page));
+	const siteTitle = website._.title || folderName;
+
+	function getBreadcrumbs(level = 0) {
+		const path = $pageStore.data.segments.slice(0, level).join('/');
+		const crumbyPage = getFolder($pageStore.data.website, path);
+		const folderLabel = getFolderLabel(crumbyPage);
+		const active = level > $pageStore.data.segments.length;
+		if (!active) return [folderLabel, ...getBreadcrumbs(level + 1)];
+		return [];
+	}
+
+	function makePageMetaTitle() {
+		if (page.url === '/') {
+			if (slogan) return `${siteTitle || pageMetaTitle} - ${slogan}`;
+			return siteTitle || pageMetaTitle;
+		}
+
+		const breadcrumbs = getBreadcrumbs().slice(1, -1).reverse();
+		const breadcrumbSegment = breadcrumbs.length ? `${breadcrumbs.join(' - ')}` : '';
+		return `${pageMetaTitle} - ${breadcrumbSegment} - ${siteTitle}`;
+	}
+
+	function getFavicon() {
+		if (website._?.icon)
+			return `data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 20 90 60%22><text y=%22.9em%22 font-size=%2290%22>${website._.icon}</text></svg>`;
+		if (data.files.favicon.exists) return '/favicon.png';
+		return false;
+	}
+
+	const favicon = getFavicon();
+
+	$effect(() => {
+		// Update website on file change
+		if (import.meta.hot) {
+			import.meta.hot.on('vowel:update', ({ path, file }) => {
+				let page = getPage(website, path);
+
+				for (const key in file) {
+					page[key] = file[key];
+				}
+			});
+		}
+	});
+</script>
+
+<!-- svelte-ignore state_referenced_locally -->
+<!-- svelte-ignore state_referenced_locally -->
+<svelte:head>
+	<title>{makePageMetaTitle()}</title>
+	<meta property="”og:url”" content={page.url} />
+	<meta property="og:site_name" content={website._.title || folderName} />
+	{#if page.hasOwnProperty('description') || page.imputedProperties?.hasOwnProperty('description')}
+		<meta
+			property="og:description"
+			content={page.description || page.imputedProperties.description}
+		/>
+	{/if}
+	{#if favicon}
+		<link rel="icon" href={favicon} />
+	{/if}
+	{#if data.files.css.exists && !dev}
+		<!-- Import styles in build mode -->
+		<link rel="stylesheet" href="styles.css" />
+	{/if}
+</svelte:head>
+
+<DefaultStyles />
+
+<div data-sveltekit-preload-data="hover" class={createPageClass(page.url)}>
+	<header>
+		{#if website._.logo}
+			<a href="/" class="site-logo">
+				<img alt="website logo" src={website._.logo} />
+			</a>
+		{/if}
+		{#if siteTitle}
+			<a href="/" class="site-title">{siteTitle}</a>
+		{/if}
+		{#if website._.slogan}
+			<p class="slogan">{website._.slogan}</p>
+		{/if}
+		<Nav folder={data.website} segments={data.path.split('/')} />
+		<nav class="breadcrumbs" aria-label="Breadcrumb">
+			<Breadcrumbs level={0} />
+		</nav>
+	</header>
+	<main>
+		<Page level={0} {page} {website} path={data.path} />
+	</main>
+	<aside class="sitemap">
+		<Sitemap section={data.website} segments={data.path.split('/')} root />
+	</aside>
+	<footer>
+		© {website._.author ? website._.author + ' ' : ''}
+		{new Date().getFullYear()}
+	</footer>
+</div>

package/src/routes/feed.xml/+server.js

@@ -0,0 +1,120 @@
+import xml from 'xml';
+import { render } from 'svelte/server';
+import Page from './../../lib/components/Page.svelte';
+import {
+	getPagesByFolder,
+	getFileLabel,
+	processMarkdownFiles,
+	loadCache
+} from '../../lib/utilities';
+
+export const prerender = true;
+
+export async function GET({}) {
+	/*
+    It's wasteful to load everything here, but it should only run
+    once at buildtime, so it's not a significant issue.
+  */
+	const initialCache = await loadCache($home[0]);
+
+	const { folder: website } = await processMarkdownFiles(initialCache);
+
+	const allPages = getPagesByFolder(website, '/');
+
+	const sortedPages = allPages.filter((page) => page.hasOwnProperty('date'));
+
+	const site_title = {
+		title: website._.title || 'Untitled'
+	};
+
+	const feed = [];
+
+	feed.push({
+		_attr: {
+			xmlns: 'http://www.w3.org/2005/Atom'
+		}
+	});
+
+	feed.push(site_title);
+
+	if (website._.domain)
+		feed.push(
+			{
+				link: {
+					_attr: {
+						rel: 'self',
+						href: `${website._.domain}/feed`
+					}
+				}
+			},
+			{
+				id: 'https://littlefair.ca/feed'
+			}
+		);
+
+	if (website._.author)
+		feed.push(
+			{
+				author: {
+					name: 'Sam Littlefair'
+				}
+			},
+			{ rights: `Copyright (c) ${new Date().getFullYear()} Sam Littlefair` }
+		);
+
+	feed.push(
+		...sortedPages.map((page) => {
+			const url = website._.domain ? website._.domain + page.url : 'undefined';
+			const entry = [
+				{
+					title: getFileLabel(page)
+				},
+				{
+					link: {
+						_attr: {
+							rel: 'alternate',
+							href: url
+						}
+					}
+				},
+				{ id: url },
+				{ updated: page.date }
+			];
+
+			if (page.description) {
+				entry.push({
+					summary: page.description
+				});
+			}
+
+			if (page.author) {
+				entry.push({
+					author: {
+						name: page.author
+					}
+				});
+			}
+
+			entry.push({
+				content: [
+					{ _attr: { type: 'html' } },
+					render(Page, { props: { page, level: 0, format: 'xml' } }).html
+				]
+			});
+
+			return {
+				entry
+			};
+		})
+	);
+
+	const headers = {
+		'Cache-Control': 'max-age=0, s-maxage=3600',
+		'Content-Type': 'text/xml'
+	};
+
+	const response = new Response(`<?xml version="1.0" encoding="utf-8"?>` + xml({ feed }, true), {
+		headers
+	});
+	return response;
+}

package/src/routes/robots.txt/+server.js

@@ -0,0 +1,54 @@
+import { processMarkdownFiles, loadCache } from '../../lib/utilities';
+
+/*
+	TODO: Will this work at this location? Otherwise, figure out how to move it.
+*/
+
+const allow = `Allow: /`;
+const disallow = `Disallow: /`;
+
+const google_images = `User-agent: Googlebot-Image`;
+
+const google_general = `User-agent: Google-Extended`;
+
+const gpt_bot = `User-agent: GPTBot`;
+
+const gpt_user = `User-agent: ChatGPT-User`;
+
+const common_crawl = `User-agent: CCBot`;
+
+export const prerender = true;
+
+export async function GET({}) {
+	/*
+    It's wasteful to load everything here, but it should only run
+    once at buildtime, so it's not a significant issue.
+  */
+	const initialCache = await loadCache($home[0]);
+
+	const { folder: website } = await processMarkdownFiles(initialCache);
+
+	const declarations = [];
+
+	declarations.push(
+		google_general + '\n' + (website._.robots?.google === false ? disallow : allow)
+	);
+	declarations.push(
+		google_images + '\n' + (website._.robots?.google_images === false ? disallow : allow)
+	);
+	declarations.push(gpt_bot + '\n' + (website._.robots?.ai === false ? disallow : allow));
+	declarations.push(gpt_user + '\n' + (website._.robots?.ai === false ? disallow : allow));
+	declarations.push(common_crawl + '\n' + (website._.robots?.ai === false ? disallow : allow));
+
+	const text = declarations.join('\n\n') || '';
+
+	const headers = {
+		'Cache-Control': 'max-age=0, s-maxage=3600',
+		'Content-Type': 'text/plain'
+	};
+
+	const response = new Response(text, {
+		headers
+	});
+	return response;
+}

package/src/routes/sitemap.xml/+server.js

@@ -0,0 +1,68 @@
+import { getPagesByFolder, processMarkdownFiles, loadCache } from '../../lib/utilities';
+
+export const prerender = true;
+
+export async function GET({}) {
+	const fallback = {
+		folder: {}
+	};
+
+	const initialCache = await loadCache($home[0]);
+
+	const { folder: website } = await processMarkdownFiles(initialCache);
+
+	const pages = getPagesByFolder(website, '/');
+
+	const site_title = {
+		title: website._.title || 'Untitled'
+	};
+
+	const domain = website._.domain || false;
+
+	function createEntry(page) {
+		return `
+		<url>
+			<loc>${new URL(page.url || '/', domain)}</loc>
+			<changefreq>daily</changefreq>
+			<priority>0.7</priority>
+		</url>
+		`;
+	}
+
+	function createSitemap(pages, domain) {
+		return `<?xml version="1.0" encoding="UTF-8" ?>
+	<urlset
+  xmlns="https://www.sitemaps.org/schemas/sitemap/0.9"
+  xmlns:news="https://www.google.com/schemas/sitemap-news/0.9"
+  xmlns:xhtml="https://www.w3.org/1999/xhtml"
+  xmlns:mobile="https://www.google.com/schemas/sitemap-mobile/1.0"
+  xmlns:image="https://www.google.com/schemas/sitemap-image/1.1"
+  xmlns:video="https://www.google.com/schemas/sitemap-video/1.1"
+>
+  <url>
+    <loc>${domain}</loc>
+    <changefreq>daily</changefreq>
+    <priority>0.7</priority>
+  </url>
+	  ${pages.map(createEntry).join('')}
+</urlset>
+  `;
+	}
+
+	function createFallBackSitemap() {
+		return `<?xml version="1.0" encoding="UTF-8" ?><message>Specify a 'domain' in /settings.md</message>`;
+	}
+
+	const sitemap = domain ? createSitemap(pages, domain) : createFallBackSitemap();
+
+	const headers = {
+		'Cache-Control': 'max-age=0, s-maxage=3600',
+		'Content-Type': 'text/xml'
+	};
+
+	const response = new Response(sitemap, {
+		headers
+	});
+
+	return response;
+}

package/svelte.config.js

@@ -0,0 +1,32 @@
+import adapter from '@sveltejs/adapter-static';
+import path, { join } from 'path';
+
+const demoDir = process.cwd() + '/content';
+const NPMRunDev = process.argv[2] === 'dev';
+const isBuild = process.argv[2] === 'build';
+const receivedHomePath = NPMRunDev || isBuild ? false : process.argv[2];
+const homeDir = receivedHomePath || demoDir;
+const relativePathToHome = path.relative(process.cwd(), homeDir);
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+	kit: {
+		// adapter-auto only supports some environments, see https://kit.svelte.dev/docs/adapter-auto for a list.
+		// If your environment is not supported or you settled on a specific environment, switch out the adapter.
+		// See https://kit.svelte.dev/docs/adapters for more information about adapters.
+		adapter: adapter({
+			pages: join(relativePathToHome, '.output'),
+			assets: join(relativePathToHome, '.output'),
+			strict: false
+		}),
+		files: {
+			assets: join(relativePathToHome, 'assets')
+		},
+		prerender: {
+			handleHttpError: 'warn',
+			entries: ['*', '/', '/robots.txt', '/sitemap.xml', '/feed.xml']
+		}
+	}
+};
+
+export default config;

package/vercel.json

@@ -0,0 +1,5 @@
+{
+  "cleanUrls": true,
+  "outputDirectory": "./.output",
+  "buildCommand": null
+}

package/vite.config.js

@@ -0,0 +1,72 @@
+import { sveltekit } from '@sveltejs/kit/vite';
+import { defineConfig } from 'vite';
+import path from 'path';
+import { readMarkdownFile, loadCache } from './src/lib/utilities/index';
+
+const demoDir = process.cwd() + '/content';
+const NPMRunDev = process.argv[2] === 'dev';
+const isBuild = process.argv[2] === 'build';
+const receivedHomePath = NPMRunDev || isBuild ? false : process.argv[2];
+
+const homeDir = receivedHomePath || demoDir;
+
+const $home = [homeDir];
+
+export default defineConfig({
+	plugins: [
+		sveltekit(),
+		{
+			// Hot reload markdown
+			name: 'markdown:watch',
+			configureServer(server) {
+				console.log(`Root directory: ${homeDir}`);
+				server.watcher.add(homeDir);
+				server.watcher.on('change', async (homePath, stats) => {
+					if (homePath.endsWith('.md')) {
+						// Remove `.md`
+						const cache = await loadCache(homeDir);
+						const file = await readMarkdownFile(homePath, cache);
+						Object.assign(file, file.frontmatter);
+						const relativePath = path
+							.relative(homeDir, homePath)
+							.slice(0, -3)
+							.replace(/\/?(home|settings)$/, '');
+						server.ws.send('vowel:update', {
+							path: relativePath,
+							stats,
+							file
+						});
+					}
+				});
+			}
+		}
+	],
+	define: { $home },
+	optimizeDeps: {
+		exclude: ['svelte', 'remark', 'remark-frontmatter', 'remark-html'],
+		include: [
+			'micromark',
+			'unified',
+			'fault',
+			'url-metadata',
+			'any-date-parser',
+			'any-date-parser/src/formats/ago/ago.js',
+			'any-date-parser/src/formats/ago/ago.js',
+			'any-date-parser/src/formats/chinese/chinese.js',
+			'any-date-parser/src/formats/dayMonth/dayMonth.js',
+			'any-date-parser/src/formats/dayMonthname/dayMonthname.js',
+			'any-date-parser/src/formats/monthDay/monthDay.js',
+			'any-date-parser/src/formats/monthnameDay/monthnameDay.js',
+			'any-date-parser/src/formats/today/today.js'
+		]
+	},
+	server: {
+		fs: {
+			strict: false,
+			allow: homeDir
+		}
+	},
+	resolve: {
+		// extensions: ['.css']
+	}
+});

package/index.js

@@ -1,28 +0,0 @@
-const vowels = ['a', 'e', 'i', 'o', 'u'];
-
-function isVowel(c) {
-  return vowels.indexOf(c.toLowerCase()) !== -1;
-}
-
-function includesVowel(s) {
-  for (let i = 0; i < s.length; i += 1) {
-    if (isVowel(s.charAt(i))) return true;
-  }
-  return false;
-}
-
-function startsWithVowel(s) {
-  return vowels.some(v => s.toLowerCase().startsWith(v));
-}
-
-function endsWithVowel(s) {
-  return vowels.some(v => s.toLowerCase().endsWith(v));
-}
-
-module.exports = {
-  vowels,
-  isVowel,
-  includesVowel,
-  startsWithVowel,
-  endsWithVowel,
-};