create-qpq-app 0.1.5

package/template/docusaurus/docusaurus.config.ts

@@ -0,0 +1,181 @@
+import type * as Preset from '@docusaurus/preset-classic';
+import type {Config} from '@docusaurus/types';
+import type {PrismTheme} from 'prism-react-renderer';
+
+// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
+
+// Code highlighting palette matching the landing page's code window
+// (qpq/spa/src/index.css tok-* classes).
+const qpqPrismTheme: PrismTheme = {
+  plain: {
+    color: '#c9dde8',
+    backgroundColor: 'transparent',
+  },
+  styles: [
+    {types: ['keyword', 'operator', 'atrule'], style: {color: '#7dd3fc'}},
+    {types: ['function', 'function-variable'], style: {color: '#8df6ff'}},
+    {types: ['string', 'char', 'attr-value', 'url', 'regex'], style: {color: '#fbbf77'}},
+    {types: ['class-name', 'maybe-class-name', 'builtin', 'namespace'], style: {color: '#86efac'}},
+    {types: ['comment', 'prolog', 'doctype', 'cdata'], style: {color: '#5c7181', fontStyle: 'italic' as const}},
+    {types: ['number', 'boolean', 'constant', 'symbol', 'property', 'attr-name', 'variable'], style: {color: '#c4b5fd'}},
+    {types: ['punctuation'], style: {color: '#8fa8b8'}},
+    {types: ['tag', 'selector'], style: {color: '#7dd3fc'}},
+    {types: ['deleted'], style: {color: '#ff5f57'}},
+    {types: ['inserted'], style: {color: '#28c840'}},
+  ],
+};
+
+const config: Config = {
+  title: 'quidproquo',
+  tagline: 'Write the story, run it anywhere',
+  favicon: 'img/favicon.svg',
+
+  // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
+  future: {
+    v4: true, // Improve compatibility with the upcoming Docusaurus v4
+  },
+
+  // Set the production url of your site here
+  url: 'https://docs.quidproquojs.com',
+  // Set the /<baseUrl>/ pathname under which your site is served
+  // For GitHub pages deployment, it is often '/<projectName>/'
+  baseUrl: '/',
+
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
+  organizationName: 'joe-coady', // Usually your GitHub org/user name.
+  projectName: 'quidproquo', // Usually your repo name.
+
+  onBrokenLinks: 'throw',
+  markdown: {
+    hooks: {
+      onBrokenMarkdownLinks: 'warn',
+    },
+  },
+
+  // Even if you don't use internationalization, you can use this field to set
+  // useful metadata like html lang. For example, if your site is Chinese, you
+  // may want to replace "en" with "zh-Hans".
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  // Same font stack as the landing page (qpq/spa/index.html)
+  headTags: [
+    {
+      tagName: 'link',
+      attributes: {rel: 'preconnect', href: 'https://fonts.googleapis.com'},
+    },
+    {
+      tagName: 'link',
+      attributes: {rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: 'anonymous'},
+    },
+  ],
+  stylesheets: [
+    'https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@400;500;600;700&family=Inter:wght@400;500;600&family=JetBrains+Mono:ital,wght@0,400;0,500;1,400&display=swap',
+  ],
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          routeBasePath: '/',
+          sidebarPath: './sidebars.ts',
+          editUrl:
+            'https://github.com/joe-coady/quidproquo/tree/main/quidproquojs.com/docusaurus/',
+        },
+        blog: false,
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themeConfig: {
+    // Replace with your project's social card
+    image: 'img/docusaurus-social-card.jpg',
+    colorMode: {
+      defaultMode: 'dark',
+      disableSwitch: true,
+      respectPrefersColorScheme: false,
+    },
+    navbar: {
+      title: 'quidproquo',
+      logo: {
+        alt: 'quidproquo logo',
+        src: 'img/qpq-logo.svg',
+        href: 'https://quidproquojs.com',
+        target: '_self',
+      },
+      items: [
+        {
+          type: 'docSidebar',
+          sidebarId: 'tutorialSidebar',
+          position: 'left',
+          label: 'Documentation',
+        },
+        {
+          type: 'docSidebar',
+          sidebarId: 'apiSidebar',
+          position: 'left',
+          label: 'API Reference',
+        },
+        {
+          href: 'https://quidproquojs.com',
+          label: 'quidproquojs.com',
+          position: 'right',
+        },
+        {
+          href: 'https://github.com/joe-coady/quidproquo',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      links: [
+        {
+          title: 'Documentation',
+          items: [
+            {
+              label: 'Getting Started',
+              to: '/getting-started',
+            },
+            {
+              label: 'Core Concepts',
+              to: '/core-concepts',
+            },
+            {
+              label: 'API Reference',
+              to: '/api',
+            },
+          ],
+        },
+        {
+          title: 'Community',
+          items: [
+            {
+              label: 'GitHub',
+              href: 'https://github.com/joe-coady/quidproquo',
+            },
+            {
+              label: 'quidproquojs.com',
+              href: 'https://quidproquojs.com',
+            },
+          ],
+        },
+      ],
+      copyright: `© ${new Date().getFullYear()} quidproquo — write the story, run it anywhere.`,
+    },
+    prism: {
+      theme: qpqPrismTheme,
+      darkTheme: qpqPrismTheme,
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;

package/template/docusaurus/gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

package/template/docusaurus/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "docusaurus",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Documentation site for Quidproquo framework",
+  "scripts": {
+    "docusaurus": "docusaurus",
+    "start": "docusaurus start --port 8180",
+    "build": "docusaurus build",
+    "swizzle": "docusaurus swizzle",
+    "deploy": "docusaurus deploy",
+    "clear": "docusaurus clear",
+    "serve": "docusaurus serve",
+    "write-translations": "docusaurus write-translations",
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "typecheck": "tsc"
+  },
+  "dependencies": {
+    "@docusaurus/core": "3.10.1",
+    "@docusaurus/faster": "3.10.1",
+    "@docusaurus/preset-classic": "3.10.1",
+    "@mdx-js/react": "^3.0.0",
+    "clsx": "^2.0.0",
+    "prism-react-renderer": "^2.3.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "3.10.1",
+    "@docusaurus/tsconfig": "3.10.1",
+    "@docusaurus/types": "3.10.1",
+    "typescript": "~5.6.2"
+  },
+  "browserslist": {
+    "production": [
+      ">0.5%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 3 chrome version",
+      "last 3 firefox version",
+      "last 5 safari version"
+    ]
+  },
+  "engines": {
+    "node": ">=18.0"
+  }
+}

package/template/docusaurus/sidebars.ts

@@ -0,0 +1,27 @@
+import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+
+const sidebars: SidebarsConfig = {
+  tutorialSidebar: [
+    'index',
+    'getting-started',
+    'core-concepts',
+    'use-cases',
+    'architecture-overview',
+  ],
+  
+  apiSidebar: [
+    'api/index',
+    {
+      type: 'category',
+      label: 'Config',
+      items: [{type: 'autogenerated', dirName: 'config'}],
+    },
+    {
+      type: 'category',
+      label: 'Action Requesters',
+      items: [{type: 'autogenerated', dirName: 'actions'}],
+    },
+  ],
+};
+
+export default sidebars;

package/template/docusaurus/src/components/HomepageFeatures/index.tsx

@@ -0,0 +1,72 @@
+import clsx from 'clsx';
+import type {ReactNode} from 'react';
+import Heading from '@theme/Heading';
+
+import styles from './styles.module.css';
+
+type FeatureItem = {
+  title: string;
+  Svg: React.ComponentType<React.ComponentProps<'svg'>>;
+  description: ReactNode;
+};
+
+const FeatureList: FeatureItem[] = [
+  {
+    title: 'Easy to Use',
+    Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
+    description: (
+      <>
+        Docusaurus was designed from the ground up to be easily installed and
+        used to get your website up and running quickly.
+      </>
+    ),
+  },
+  {
+    title: 'Focus on What Matters',
+    Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
+    description: (
+      <>
+        Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
+        ahead and move your docs into the <code>docs</code> directory.
+      </>
+    ),
+  },
+  {
+    title: 'Powered by React',
+    Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
+    description: (
+      <>
+        Extend or customize your website layout by reusing React. Docusaurus can
+        be extended while reusing the same header and footer.
+      </>
+    ),
+  },
+];
+
+function Feature({title, Svg, description}: FeatureItem) {
+  return (
+    <div className={clsx('col col--4')}>
+      <div className="text--center">
+        <Svg className={styles.featureSvg} role="img" />
+      </div>
+      <div className="text--center padding-horiz--md">
+        <Heading as="h3">{title}</Heading>
+        <p>{description}</p>
+      </div>
+    </div>
+  );
+}
+
+export default function HomepageFeatures(): ReactNode {
+  return (
+    <section className={styles.features}>
+      <div className="container">
+        <div className="row">
+          {FeatureList.map((props, idx) => (
+            <Feature key={idx} {...props} />
+          ))}
+        </div>
+      </div>
+    </section>
+  );
+}

package/template/docusaurus/src/components/HomepageFeatures/styles.module.css

@@ -0,0 +1,11 @@
+.features {
+  display: flex;
+  align-items: center;
+  padding: 2rem 0;
+  width: 100%;
+}
+
+.featureSvg {
+  height: 200px;
+  width: 200px;
+}