@heyo-sh/create-heyo-docs 1.0.1 → 3.0.0

package/templates/next/content/essentials/callouts.mdx

@@ -1,34 +0,0 @@
----
-title: Callouts
-description: Draw attention to a tip, warning, prerequisite, or result.
----
-
-# Callouts
-
-Use a callout when a reader should not miss a detail.
-
-## Add a tip
-
-<Callout type="tip" title="Keep examples focused">
-  Show one idea at a time so readers can apply it quickly.
-</Callout>
-
-## Choose a type
-
-| Type                  | Use it for             |
-| --------------------- | ---------------------- |
-| `info` or `note`      | Helpful context        |
-| `tip`                 | A recommended approach |
-| `check`               | A successful result    |
-| `warning` or `danger` | A real consequence     |
-
-<Callout type="warning" title="Preview before publishing">
-  Run the production build after changing navigation or MDX.
-</Callout>
-
-## Keep it short
-
-<Callout type="info" title="Configuration and content work together">
-  Navigation belongs in <code>heyo-docs.config.ts</code>. Titles and
-  descriptions belong in page frontmatter.
-</Callout>

package/templates/next/content/essentials/code-blocks.mdx

@@ -1,43 +0,0 @@
----
-title: Code Blocks
-description: Add clear, copyable commands and configuration examples.
----
-
-# Code Blocks
-
-Show one task per example. Add a language so the code is easy to read.
-
-## Add a command
-
-```bash
-bun run dev
-bun run build
-```
-
-## Add a file name
-
-Use `CodeBlock` when the file name helps explain where the code belongs.
-
-<CodeBlock language="ts" title="heyo-docs.config.ts" showLineNumbers>
-  {`export default heyoDocs({
-  title: "Orbit Docs",
-  content: "content",
-  theme: "grain",
-});`}
-</CodeBlock>
-
-## Show alternatives
-
-Use `CodeBlockGroup` for equivalent commands, such as package managers.
-
-<CodeBlockGroup defaultValue="bun" variant="line">
-  <CodeBlock language="bash" title="bun">
-    {"bun add @heyo-sh/heyo-docs"}
-  </CodeBlock>
-  <CodeBlock language="bash" title="npm">
-    {"npm install @heyo-sh/heyo-docs"}
-  </CodeBlock>
-  <CodeBlock language="bash" title="pnpm">
-    {"pnpm add @heyo-sh/heyo-docs"}
-  </CodeBlock>
-</CodeBlockGroup>

package/templates/next/content/essentials/lists.mdx

@@ -1,36 +0,0 @@
----
-title: Lists
-description: Use lists to make choices and short steps easy to scan.
----
-
-# Lists
-
-Use a list when readers need to scan choices or follow a short sequence.
-
-## Add a bullet list
-
-Use bullets when the order does not matter.
-
-- Keep MDX pages in the `content` directory.
-- Add important routes to `heyo-docs.config.ts`.
-- Build the project before publishing.
-
-## Add numbered steps
-
-Use numbers when the order matters.
-
-1. Create an MDX file.
-2. Add its path to a sidebar section.
-3. Start the development server.
-4. Review the rendered route.
-
-## Add one level when needed
-
-Use a nested list only for a direct relationship.
-
-- Prepare the release:
-  - Review the changed pages.
-  - Confirm navigation order.
-  - Run the production build.
-
-Use `Steps` when each step needs a command or more explanation.

package/templates/next/content/essentials/tables.mdx

@@ -1,30 +0,0 @@
----
-title: Tables
-description: Compare a small set of options with a simple Markdown table.
----
-
-# Tables
-
-Use a table to compare the same details across a small number of options.
-
-## Add a table
-
-| Setting   | Purpose                                | Example                      |
-| --------- | -------------------------------------- | ---------------------------- |
-| `content` | Directory containing MDX source files. | `"content"`                  |
-| `theme`   | Built-in documentation theme.          | `"grain"`                    |
-| `mode`    | Initial color preference.              | `"system"`                   |
-| `siteUrl` | Canonical public site origin.          | `"https://docs.example.com"` |
-
-## Keep it readable
-
-Use short headings and short cells. Put long explanations in a section below
-the table.
-
-| Use a table for        | Use a section for      |
-| ---------------------- | ---------------------- |
-| Compact comparisons    | A multi-step procedure |
-| Option defaults        | A detailed explanation |
-| Short reference values | A large code example   |
-
-Use a numbered list when readers must act in a specific order.

package/templates/next/content/essentials/tabs.mdx

@@ -1,40 +0,0 @@
----
-title: Tabs
-description: Let readers switch between equivalent commands or platforms.
----
-
-# Tabs
-
-Use tabs for equivalent ways to complete the same task. Keep their labels
-short.
-
-## Add tabs
-
-<Tabs defaultValue="typescript" variant="line">
-  <Tab title="JavaScript" value="javascript">
-    Import the package from your JavaScript entry point.
-  </Tab>
-  <Tab title="TypeScript" value="typescript">
-    Import the package with full type information and keep configuration typed.
-  </Tab>
-</Tabs>
-
-## Compare platforms
-
-Each tab should answer the same question for a different platform.
-
-<Tabs defaultValue="vercel" variant="line">
-  <Tab title="Vercel" value="vercel">
-    Connect the repository and let Vercel detect the framework.
-  </Tab>
-  <Tab title="Cloudflare" value="cloudflare">
-    Deploy the generated static site when your team already uses Cloudflare.
-  </Tab>
-  <Tab title="Static host" value="static">
-    Upload the build output to any host that serves static files.
-  </Tab>
-</Tabs>
-
-<Callout type="tip" title="Use tabs sparingly">
-  Use headings or <code>Steps</code> for information that every reader needs.
-</Callout>

package/templates/next/content/essentials/text-styling.mdx

@@ -1,43 +0,0 @@
----
-title: Text Styling
-description: Use simple Markdown for headings, emphasis, links, and quotes.
----
-
-# Text Styling
-
-Use regular Markdown for most documentation. Keep the text short and let
-headings show readers where to look next.
-
-## Add headings
-
-Use `##` for a main section and `###` only for a useful subsection.
-
-```md
-## Configure navigation
-
-Add pages in the order readers should follow.
-
-### Add an external resource
-
-Link to a resource outside your documentation.
-```
-
-## Highlight important text
-
-Use **bold** for an important choice and inline `code` for values readers need
-to copy.
-
-```md
-Set `content: "content"` in `heyo-docs.config.ts`.
-
-Run `bun run build` before you publish.
-```
-
-## Write useful links
-
-Use the destination as the link text. It is easier to scan than a raw URL.
-
-Read the [Quickstart](/quickstart) before changing
-[site configuration](/configuration).
-
-> Keep one idea in each short paragraph.

package/templates/next/content/getting-started.mdx

@@ -1,16 +0,0 @@
----
-title: Getting started
-description: Run your new documentation site locally.
----
-
-# Getting started
-
-Install dependencies with your chosen package manager and start the development server.
-
-## Create a page
-
-Create `content/guides/deploying.mdx` to get the `/guides/deploying` route. Its frontmatter controls its title and description.
-
-## Configure the documentation
-
-Use `heyo-docs.config.ts` to change the title, colors, tabs, sidebar groups, footer links and selected theme without regenerating your project. Add pages or directories to a section's `pages` list to control the sidebar order.

package/templates/next/content/mdx-components.mdx

@@ -1,41 +0,0 @@
----
-title: MDX components
-description: Every built-in MDX component is available without an import.
----
-
-# MDX components
-
-Every built-in component is available in a Next.js MDX page without an import.
-
-## Callout
-
-<Callout
-  type="tip"
-  title="No imports needed"
-  description="Use the documentation components directly in your MDX files."
-/>
-
-## Tabs
-
-<Tabs defaultValue="npm" variant="line">
-  <Tab title="npm" value="npm">
-    npm run dev
-  </Tab>
-  <Tab title="Bun" value="bun">
-    bun run dev
-  </Tab>
-</Tabs>
-
-## Code blocks
-
-`CodeBlock` preserves every newline as a hard code line.
-
-<CodeBlock language="tsx" title="app/page.tsx" showLineNumbers>
-  {`export default function Page() {
-  return <h1>Hello</h1>;
-}`}
-</CodeBlock>
-
-## More components
-
-`Accordion`, `Button`, `Columns`, `File`, `GitHub`, `HoverCard`, `Image`, `Mermaid`, `RelatedTopics`, `Steps`, `Tree`, `Video`, and the remaining primitives use the same MDX contract as every Heyo Docs template.

package/templates/next/content/openapi-petstore.json

@@ -1,160 +0,0 @@
-{
-  "openapi": "3.0.4",
-  "info": {
-    "title": "Swagger Petstore - OpenAPI 3.0",
-    "description": "A small, read-only extract of the public Swagger Petstore schema for debugging Heyo Docs. Source: https://petstore3.swagger.io/api/v3/openapi.json",
-    "version": "1.0.27",
-    "license": {
-      "name": "Apache 2.0",
-      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
-    }
-  },
-  "servers": [
-    {
-      "url": "https://petstore3.swagger.io/api/v3",
-      "description": "Swagger Petstore public server"
-    }
-  ],
-  "paths": {
-    "/pet/findByStatus": {
-      "get": {
-        "tags": ["pet"],
-        "summary": "Finds Pets by status.",
-        "description": "Multiple status values can be provided with comma separated strings.",
-        "operationId": "findPetsByStatus",
-        "parameters": [
-          {
-            "name": "status",
-            "in": "query",
-            "description": "Status values that need to be considered for filter",
-            "required": true,
-            "explode": true,
-            "schema": {
-              "type": "string",
-              "default": "available",
-              "enum": ["available", "pending", "sold"]
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "successful operation",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "array",
-                  "items": { "$ref": "#/components/schemas/Pet" }
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "Invalid status value"
-          },
-          "default": {
-            "description": "Unexpected error"
-          }
-        }
-      }
-    },
-    "/store/order/{orderId}": {
-      "get": {
-        "tags": ["store"],
-        "summary": "Find purchase order by ID.",
-        "description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.",
-        "operationId": "getOrderById",
-        "parameters": [
-          {
-            "name": "orderId",
-            "in": "path",
-            "description": "ID of order that needs to be fetched.",
-            "required": true,
-            "schema": {
-              "type": "integer",
-              "format": "int64"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "successful operation",
-            "content": {
-              "application/json": {
-                "schema": { "$ref": "#/components/schemas/Order" }
-              }
-            }
-          },
-          "400": {
-            "description": "Invalid ID supplied"
-          },
-          "404": {
-            "description": "Order not found"
-          },
-          "default": {
-            "description": "Unexpected error"
-          }
-        }
-      }
-    }
-  },
-  "components": {
-    "schemas": {
-      "Order": {
-        "type": "object",
-        "properties": {
-          "id": { "type": "integer", "format": "int64", "example": 10 },
-          "petId": {
-            "type": "integer",
-            "format": "int64",
-            "example": 198772
-          },
-          "quantity": { "type": "integer", "format": "int32", "example": 7 },
-          "shipDate": { "type": "string", "format": "date-time" },
-          "status": {
-            "type": "string",
-            "description": "Order Status",
-            "example": "approved",
-            "enum": ["placed", "approved", "delivered"]
-          },
-          "complete": { "type": "boolean" }
-        }
-      },
-      "Category": {
-        "type": "object",
-        "properties": {
-          "id": { "type": "integer", "format": "int64", "example": 1 },
-          "name": { "type": "string", "example": "Dogs" }
-        }
-      },
-      "Tag": {
-        "type": "object",
-        "properties": {
-          "id": { "type": "integer", "format": "int64" },
-          "name": { "type": "string" }
-        }
-      },
-      "Pet": {
-        "required": ["name", "photoUrls"],
-        "type": "object",
-        "properties": {
-          "id": { "type": "integer", "format": "int64", "example": 10 },
-          "name": { "type": "string", "example": "doggie" },
-          "category": { "$ref": "#/components/schemas/Category" },
-          "photoUrls": {
-            "type": "array",
-            "items": { "type": "string" }
-          },
-          "tags": {
-            "type": "array",
-            "items": { "$ref": "#/components/schemas/Tag" }
-          },
-          "status": {
-            "type": "string",
-            "description": "pet status in the store",
-            "enum": ["available", "pending", "sold"]
-          }
-        }
-      }
-    }
-  }
-}