@lukoweb/create-apitogo 0.1.21 → 0.1.23

package/dist/templates/default/js/apitogo.config.jsx

@@ -11,6 +11,9 @@ const config = {
   metadata: {
     favicon: "/Icon.png",
   },
+  docs: {
+    files: "/pages/**/*.{md,mdx}",
+  },
   navigation: [
     {
       type: "category",
@@ -21,7 +24,16 @@ const config = {
           label: "Getting Started",
           icon: "sparkles",
           items: [
-            "/introduction",
+            {
+              type: "doc",
+              file: "pages/introduction.mdx",
+              label: "Introduction",
+            },
+            {
+              type: "doc",
+              file: "pages/example.mdx",
+              label: "MDX examples",
+            },
             {
               type: "link",
               icon: "folder-cog",
@@ -61,7 +73,7 @@ const config = {
     {
       type: "file",
       input: "./apis/openapi.yaml",
-      path: "/api",
+      path: "api",
     },
   ],
 };

package/dist/templates/default/js/pages/example.mdx

@@ -1,9 +1,131 @@
 ---
-title: "Example page"
+title: MDX examples
+description:
+  Callouts, fenced code, tabbed code, tables, task lists, links, badges, and buttons available in
+  APIToGo MDX pages.
 ---
 
-:::tip
+This page lists patterns you can copy into any `.mdx` file under `pages/`. Your site title comes from
+front matter (`title` above) and appears in the sidebar for this route.
 
-Edit this page by opening the `example.mdx` file in the `pages` directory.
+<Link to="/introduction">Introduction</Link> · <Link to="/api">API reference</Link> ·{" "}
+<Badge variant="secondary">built-in</Badge> <Badge variant="outline">mdx</Badge>
+
+## Callouts (directives)
+
+:::note{title="Note"}
+
+Neutral context readers should notice.
+
+:::
+
+:::tip{title="Tip"}
+
+Suggested workflows or shortcuts.
+
+:::
+
+:::info{title="Info"}
+
+Extra detail that is not urgent.
+
+:::
+
+:::caution{title="Caution"}
+
+Something might break if misconfigured.
+
+:::
+
+:::danger{title="Danger"}
+
+Destructive or security-sensitive actions.
 
 :::
+
+## Fenced code
+
+Inline: `ApitogoConfig`, `apitogo dev`, `pages/example.mdx`.
+
+```bash
+apitogo dev
+apitogo build
+apitogo preview
+```
+
+```json
+{ "example": true }
+```
+
+```jsx
+/** @type {import('@lukoweb/apitogo').ApitogoConfig} */
+const config = {
+  site: { title: "My API docs" },
+};
+
+export default config;
+```
+
+## Tabbed code (`CodeTabs`)
+
+<CodeTabs>
+
+```bash title="curl"
+curl -sS https://httpbin.org/get
+```
+
+```bash title="HTTPie"
+http GET https://httpbin.org/get
+```
+
+```ts title="fetch"
+const res = await fetch("https://httpbin.org/get");
+console.log(await res.json());
+```
+
+</CodeTabs>
+
+<CodeTabs>
+
+```json title="JSON"
+{ "status": "ok" }
+```
+
+```yaml title="YAML"
+status: ok
+```
+
+</CodeTabs>
+
+## Table
+
+| Topic | Where to look |
+| ----- | ------------- |
+| Config | `apitogo.config.jsx` |
+| Pages | `pages/**/*.mdx` |
+| OpenAPI | `apis/openapi.yaml` |
+
+## Lists
+
+1. Edit Markdown or MDX under `pages/`.
+2. Adjust `apitogo.config.jsx`.
+3. Run `apitogo build` before deploy.
+
+Task list (GFM):
+
+- [x] Scaffold created
+- [ ] Customize for your API
+
+## Markdown
+
+> Blockquote for quotes or asides.
+
+**Bold**, _italic_, ~~strikethrough~~, and [link to API](/api).
+
+---
+
+## Button
+
+<Button variant="outline" type="button">
+  Example button
+</Button>

package/dist/templates/default/js/pages/introduction.mdx

@@ -13,4 +13,8 @@ To edit this page, open the `pages/introduction.mdx` file.
 You can find the full configuration for your APIToGo site in the `apitogo.config.jsx` file.
 
 For further information on how to customize your site, check out the
-[APIToGo documentation](https://zudoku.dev/docs).
+[APIToGo documentation](https://docs.apitogo.com).
+
+## MDX building blocks
+
+See [MDX examples](/example) for callouts, code blocks, tabs, tables, and common components.

package/dist/templates/default/ts/apitogo.config.tsx

@@ -12,6 +12,9 @@ const config: ApitogoConfig = {
   metadata: {
     favicon: "/Icon.png",
   },
+  docs: {
+    files: "/pages/**/*.{md,mdx}",
+  },
   navigation: [
     {
       type: "category",
@@ -22,7 +25,16 @@ const config: ApitogoConfig = {
           label: "Getting Started",
           icon: "sparkles",
           items: [
-            "/introduction",
+            {
+              type: "doc",
+              file: "pages/introduction.mdx",
+              label: "Introduction",
+            },
+            {
+              type: "doc",
+              file: "pages/example.mdx",
+              label: "MDX examples",
+            },
             {
               type: "link",
               icon: "folder-cog",
@@ -62,7 +74,7 @@ const config: ApitogoConfig = {
     {
       type: "file",
       input: "./apis/openapi.yaml",
-      path: "/api",
+      path: "api",
     },
   ],
 };

package/dist/templates/default/ts/pages/example.mdx

@@ -1,9 +1,132 @@
 ---
-title: "Example page"
+title: MDX examples
+description:
+  Callouts, fenced code, tabbed code, tables, task lists, links, badges, and buttons available in
+  APIToGo MDX pages.
 ---
 
-:::tip
+This page lists patterns you can copy into any `.mdx` file under `pages/`. Your site title comes from
+front matter (`title` above) and appears in the sidebar for this route.
 
-Edit this page by opening the `example.mdx` file in the `pages/docs` directory.
+<Link to="/introduction">Introduction</Link> · <Link to="/api">API reference</Link> ·{" "}
+<Badge variant="secondary">built-in</Badge> <Badge variant="outline">mdx</Badge>
+
+## Callouts (directives)
+
+:::note{title="Note"}
+
+Neutral context readers should notice.
+
+:::
+
+:::tip{title="Tip"}
+
+Suggested workflows or shortcuts.
 
 :::
+
+:::info{title="Info"}
+
+Extra detail that is not urgent.
+
+:::
+
+:::caution{title="Caution"}
+
+Something might break if misconfigured.
+
+:::
+
+:::danger{title="Danger"}
+
+Destructive or security-sensitive actions.
+
+:::
+
+## Fenced code
+
+Inline: `ApitogoConfig`, `apitogo dev`, `pages/example.mdx`.
+
+```bash
+apitogo dev
+apitogo build
+apitogo preview
+```
+
+```json
+{ "example": true }
+```
+
+```ts
+import type { ApitogoConfig } from "@lukoweb/apitogo";
+
+const config: ApitogoConfig = {
+  site: { title: "My API docs" },
+};
+
+export default config;
+```
+
+## Tabbed code (`CodeTabs`)
+
+<CodeTabs>
+
+```bash title="curl"
+curl -sS https://httpbin.org/get
+```
+
+```bash title="HTTPie"
+http GET https://httpbin.org/get
+```
+
+```ts title="fetch"
+const res = await fetch("https://httpbin.org/get");
+console.log(await res.json());
+```
+
+</CodeTabs>
+
+<CodeTabs>
+
+```json title="JSON"
+{ "status": "ok" }
+```
+
+```yaml title="YAML"
+status: ok
+```
+
+</CodeTabs>
+
+## Table
+
+| Topic | Where to look |
+| ----- | ------------- |
+| Config | `apitogo.config.tsx` |
+| Pages | `pages/**/*.mdx` |
+| OpenAPI | `apis/openapi.yaml` |
+
+## Lists
+
+1. Edit Markdown or MDX under `pages/`.
+2. Adjust `apitogo.config.tsx`.
+3. Run `apitogo build` before deploy.
+
+Task list (GFM):
+
+- [x] Scaffold created
+- [ ] Customize for your API
+
+## Markdown
+
+> Blockquote for quotes or asides.
+
+**Bold**, _italic_, ~~strikethrough~~, and [link to API](/api).
+
+---
+
+## Button
+
+<Button variant="outline" type="button">
+  Example button
+</Button>

package/dist/templates/default/ts/pages/introduction.mdx

@@ -13,4 +13,8 @@ To edit this page, open the `pages/introduction.mdx` file.
 You can find the full configuration for your APIToGo site in the `apitogo.config.tsx` file.
 
 For further information on how to customize your site, check out the
-[APIToGo documentation](https://zudoku.dev/docs).
+[APIToGo documentation](https://docs.apitogo.com).
+
+## MDX building blocks
+
+See [MDX examples](/example) for callouts, code blocks, tabs, tables, and common components.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lukoweb/create-apitogo",
-  "version": "0.1.21",
+  "version": "0.1.23",
   "keywords": [
     "react",
     "apitogo"