create-refrakt 0.9.1 → 0.9.3

package/template-next/content/docs/getting-started.md

@@ -0,0 +1,40 @@
+---
+title: Getting Started
+description: Learn how to work with your refrakt.md site
+---
+
+# Getting Started
+
+This is your first documentation page. You can find this file at `content/docs/getting-started.md`.
+
+## Project Structure
+
+Your site has two key directories:
+
+- `content/` — Markdown files that make up your pages
+- `build/` — Generated HTML output (created by `npm run build`)
+
+## Writing Content
+
+Every Markdown file in `content/` becomes a page. Add frontmatter at the top for metadata:
+
+```markdown
+---
+title: Page Title
+description: A brief description
+---
+```
+
+## Using Runes
+
+Runes are Markdoc tags that give your Markdown semantic meaning:
+
+{% hint type="note" %}
+This callout is created with the `hint` rune. Try changing the `type` attribute to `warning`, `caution`, or `check`.
+{% /hint %}
+
+## Next Steps
+
+- Add more pages by creating `.md` files in `content/`
+- Edit `content/_layout.md` to customize your site's header and navigation
+- Explore the available runes in the refrakt.md documentation

package/template-next/content/index.md

@@ -0,0 +1,18 @@
+---
+title: Welcome
+description: A new refrakt.md site
+---
+
+{% cta %}
+
+# Welcome to your site
+
+This site is built with refrakt.md — a content framework that extends Markdown with semantic runes.
+
+- [Get Started](/docs/getting-started)
+
+{% /cta %}
+
+{% hint type="note" %}
+Edit the files in `content/` to start building your site. Run `npm run build` to regenerate after changes.
+{% /hint %}

package/template-next/next.config.mjs

@@ -0,0 +1,14 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+	output: 'export',
+	transpilePackages: [
+		'@markdoc/markdoc',
+		'@refrakt-md/runes',
+		'@refrakt-md/content',
+		'@refrakt-md/types',
+		'@refrakt-md/next',
+		'@refrakt-md/transform',
+	],
+};
+
+export default nextConfig;

package/template-next/tsconfig.json

@@ -0,0 +1,21 @@
+{
+	"compilerOptions": {
+		"target": "ES2017",
+		"lib": ["dom", "dom.iterable", "esnext"],
+		"allowJs": true,
+		"skipLibCheck": true,
+		"strict": true,
+		"noEmit": true,
+		"esModuleInterop": true,
+		"module": "esnext",
+		"moduleResolution": "bundler",
+		"resolveJsonModule": true,
+		"isolatedModules": true,
+		"jsx": "preserve",
+		"incremental": true,
+		"plugins": [{ "name": "next" }],
+		"paths": { "@/*": ["./*"] }
+	},
+	"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+	"exclude": ["node_modules"]
+}

package/template-nuxt/_gitignore

@@ -0,0 +1,2 @@
+node_modules
+build

package/template-nuxt/content/_layout.md

@@ -0,0 +1,14 @@
+{% layout %}
+{% region name="header" %}
+# My Site
+{% /region %}
+
+{% region name="nav" %}
+{% nav %}
+## Docs
+
+- getting-started
+
+{% /nav %}
+{% /region %}
+{% /layout %}

package/template-nuxt/content/docs/getting-started.md

@@ -0,0 +1,40 @@
+---
+title: Getting Started
+description: Learn how to work with your refrakt.md site
+---
+
+# Getting Started
+
+This is your first documentation page. You can find this file at `content/docs/getting-started.md`.
+
+## Project Structure
+
+Your site has two key directories:
+
+- `content/` — Markdown files that make up your pages
+- `build/` — Generated HTML output (created by `npm run build`)
+
+## Writing Content
+
+Every Markdown file in `content/` becomes a page. Add frontmatter at the top for metadata:
+
+```markdown
+---
+title: Page Title
+description: A brief description
+---
+```
+
+## Using Runes
+
+Runes are Markdoc tags that give your Markdown semantic meaning:
+
+{% hint type="note" %}
+This callout is created with the `hint` rune. Try changing the `type` attribute to `warning`, `caution`, or `check`.
+{% /hint %}
+
+## Next Steps
+
+- Add more pages by creating `.md` files in `content/`
+- Edit `content/_layout.md` to customize your site's header and navigation
+- Explore the available runes in the refrakt.md documentation

package/template-nuxt/content/index.md

@@ -0,0 +1,18 @@
+---
+title: Welcome
+description: A new refrakt.md site
+---
+
+{% cta %}
+
+# Welcome to your site
+
+This site is built with refrakt.md — a content framework that extends Markdown with semantic runes.
+
+- [Get Started](/docs/getting-started)
+
+{% /cta %}
+
+{% hint type="note" %}
+Edit the files in `content/` to start building your site. Run `npm run build` to regenerate after changes.
+{% /hint %}

package/template-nuxt/nuxt.config.ts

@@ -0,0 +1,3 @@
+export default defineNuxtConfig({
+	modules: ['@refrakt-md/nuxt'],
+});

package/template-nuxt/pages/[...slug].vue

@@ -0,0 +1,107 @@
+<script setup lang="ts">
+import '@refrakt-md/lumina';
+import { loadContent } from '@refrakt-md/content';
+import { assembleThemeConfig, createTransform } from '@refrakt-md/transform';
+import { loadRunePackage, mergePackages, runes as coreRunes } from '@refrakt-md/runes';
+import manifest from '@refrakt-md/lumina/manifest';
+import { layouts } from '@refrakt-md/lumina/layouts';
+const theme = { manifest, layouts };
+import { renderPage, buildRefraktHead } from '@refrakt-md/nuxt';
+import type { RendererNode } from '@refrakt-md/types';
+import type { RefraktConfig } from '@refrakt-md/types';
+import type { Schema } from '@markdoc/markdoc';
+import { readFileSync } from 'node:fs';
+import * as path from 'node:path';
+
+const config: RefraktConfig = JSON.parse(readFileSync(path.resolve('refrakt.config.json'), 'utf-8'));
+const contentDir = path.resolve(config.contentDir);
+
+const themeModule = await import(config.theme + '/transform');
+const themeConfig = themeModule.themeConfig ?? themeModule.luminaConfig ?? themeModule.default;
+
+let transformConfig = themeConfig;
+let communityTags: Record<string, Schema> | undefined;
+
+const packageNames = config.packages ?? [];
+if (packageNames.length > 0) {
+	const loaded = await Promise.all(
+		packageNames.map((name: string) => loadRunePackage(name))
+	);
+	const coreRuneNames = new Set(Object.keys(coreRunes));
+	const merged = mergePackages(loaded, coreRuneNames, config.runes?.prefer);
+
+	communityTags = Object.keys(merged.tags).length > 0 ? merged.tags : undefined;
+
+	const { config: assembledConfig } = assembleThemeConfig({
+		coreConfig: themeConfig,
+		packageRunes: merged.themeRunes,
+		packageIcons: merged.themeIcons,
+		packageBackgrounds: merged.themeBackgrounds,
+		extensions: merged.extensions as any,
+		provenance: merged.provenance,
+	});
+
+	transformConfig = assembledConfig;
+}
+
+const transform = createTransform(transformConfig);
+
+const route = useRoute();
+
+const { data } = await useAsyncData('refrakt-' + route.path, async () => {
+	const site = await loadContent(contentDir, '/', {}, communityTags);
+
+	const currentPage = site.pages.find((p: any) => p.route.url === route.path);
+	if (!currentPage) throw createError({ statusCode: 404, message: 'Page not found' });
+
+	const renderable = transform(currentPage.renderable) as RendererNode;
+	const regions: Record<string, any> = {};
+	for (const [name, region] of currentPage.layout.regions.entries()) {
+		regions[name] = {
+			name: region.name,
+			mode: region.mode,
+			content: region.content.map((c: any) => transform(c) as RendererNode),
+		};
+	}
+
+	const pages = site.pages
+		.filter((p: any) => !p.route.draft)
+		.map((p: any) => ({
+			url: p.route.url,
+			title: (p.frontmatter.title as string) ?? '',
+			draft: false,
+		}));
+
+	return {
+		html: renderPage({
+			theme,
+			page: {
+				renderable,
+				regions,
+				title: (currentPage.frontmatter.title as string) ?? '',
+				url: currentPage.route.url,
+				pages,
+				frontmatter: currentPage.frontmatter,
+				headings: currentPage.headings,
+			},
+		}),
+		seo: buildRefraktHead({
+			title: (currentPage.frontmatter.title as string) ?? '',
+			frontmatter: currentPage.frontmatter,
+			seo: currentPage.seo,
+		}),
+	};
+});
+
+if (data.value?.seo) {
+	useHead({
+		title: data.value.seo.title,
+		meta: data.value.seo.meta,
+		script: data.value.seo.script,
+	});
+}
+</script>
+
+<template>
+	<div v-if="data" v-html="data.html" />
+</template>

package/template-nuxt/tsconfig.json

@@ -0,0 +1,3 @@
+{
+	"extends": "./.nuxt/tsconfig.json"
+}