@lukoweb/apitogo 0.2.23 → 0.2.25

package/docs/markdown/frontmatter.md

@@ -1,173 +1,173 @@
----
-sidebar_icon: scissors-line-dashed
-title: Frontmatter
-description:
-  Learn how to use YAML frontmatter in APIToGo markdown files to customize page titles,
-  descriptions, navigation, and other document properties.
----
-
-Frontmatter is metadata written in [YAML](https://yaml.org/) format at the beginning of markdown
-files, enclosed between triple dashes (`---`). It allows you to configure various aspects of your
-pages without affecting the visible content.
-
-In APIToGo, frontmatter enables you to customize page titles, descriptions, navigation settings, and
-other document properties. Here are all the supported properties:
-
-## Properties
-
-### `title`
-
-Sets the page title that appears in the browser tab and as the document title.
-
-```md
----
-title: My Page Title
----
-```
-
-### `description`
-
-Provides a description for the page, which can be used for SEO and content summaries.
-
-```md
----
-description: This page explains how to use APIToGo's markdown features.
----
-```
-
-### `category`
-
-Assigns the page to a specific category for organizational purposes. This will be shown above the
-main heading of the document.
-
-```md
----
-category: Getting Started
----
-```
-
-### `navigation_label`
-
-_Deprecated (`sidebar_label`)_
-
-Sets a custom label for the page in the sidebar navigation, allowing you to use a shorter or
-different title than the main page title.
-
-```md
----
-title: My Very Long Documentation Page Title
-navigation_label: Short Title
----
-```
-
-### `navigation_icon`
-
-_Deprecated (`sidebar_icon`)_
-
-Specifies a [Lucide icon](https://lucide.dev/icons) to display next to the page in the sidebar
-navigation.
-
-```md
----
-navigation_icon: compass
----
-```
-
-### `navigation_display`
-
-Specifies the display property of the navigation item. See the
-[Navigation guide](/docs/configuration/navigation#display-control)
-
-```md
----
-navigation_display: auth
----
-```
-
-### `toc`
-
-Controls whether the table of contents is displayed for the page. Set to `false` to hide the table
-of contents.
-
-```md
----
-toc: false
----
-```
-
-### `disable_pager`
-
-Controls whether the previous/next page navigation is displayed at the bottom of the page. Set to
-`true` to disable it.
-
-```md
----
-disable_pager: true
----
-```
-
-### `draft`
-
-Marks a document as a draft. Draft documents are only visible when running in development mode and
-are excluded from production builds. This is useful for working on content that isn't ready to be
-published.
-
-```md
----
-draft: true
----
-```
-
-:::info
-
-When `draft: true` is set:
-
-- The document will be visible when running `npx apitogo run`
-- The document will be excluded from builds created with `npx apitogo build`
-- The document won't appear in the navigation or be accessible via URL in production
-
-:::
-
-### `lastModifiedTime`
-
-The last modified timestamp for the page. This property is automatically set by APIToGo during the
-build process based on the Git commit history. You generally should not set this manually.
-
-If you need to override the automatically detected date, you can set it explicitly:
-
-```md
----
-lastModifiedTime: 2025-11-20T10:30:00.000Z
----
-```
-
-::if{mode=opensource}
-
-:::info
-
-For accurate last modified dates in deployment environments, ensure full Git history is available
-during builds. See the [Vercel deployment guide](/docs/deploy/vercel#accurate-last-modified-dates)
-for configuration details.
-
-:::
-
-::
-
-## Complete Example
-
-Here's an example showing multiple frontmatter properties used together:
-
-```md title=documentation.md
----
-title: Advanced Configuration Guide
-description: Learn how to configure advanced features in APIToGo
-category: Configuration
-navigation_label: Advanced Config
-navigation_icon: settings
-toc: true
-disable_pager: false
-draft: false
----
-
-This page content follows the frontmatter...
-```
+---
+sidebar_icon: scissors-line-dashed
+title: Frontmatter
+description:
+  Learn how to use YAML frontmatter in APIToGo markdown files to customize page titles,
+  descriptions, navigation, and other document properties.
+---
+
+Frontmatter is metadata written in [YAML](https://yaml.org/) format at the beginning of markdown
+files, enclosed between triple dashes (`---`). It allows you to configure various aspects of your
+pages without affecting the visible content.
+
+In APIToGo, frontmatter enables you to customize page titles, descriptions, navigation settings, and
+other document properties. Here are all the supported properties:
+
+## Properties
+
+### `title`
+
+Sets the page title that appears in the browser tab and as the document title.
+
+```md
+---
+title: My Page Title
+---
+```
+
+### `description`
+
+Provides a description for the page, which can be used for SEO and content summaries.
+
+```md
+---
+description: This page explains how to use APIToGo's markdown features.
+---
+```
+
+### `category`
+
+Assigns the page to a specific category for organizational purposes. This will be shown above the
+main heading of the document.
+
+```md
+---
+category: Getting Started
+---
+```
+
+### `navigation_label`
+
+_Deprecated (`sidebar_label`)_
+
+Sets a custom label for the page in the sidebar navigation, allowing you to use a shorter or
+different title than the main page title.
+
+```md
+---
+title: My Very Long Documentation Page Title
+navigation_label: Short Title
+---
+```
+
+### `navigation_icon`
+
+_Deprecated (`sidebar_icon`)_
+
+Specifies a [Lucide icon](https://lucide.dev/icons) to display next to the page in the sidebar
+navigation.
+
+```md
+---
+navigation_icon: compass
+---
+```
+
+### `navigation_display`
+
+Specifies the display property of the navigation item. See the
+[Navigation guide](/docs/configuration/navigation#display-control)
+
+```md
+---
+navigation_display: auth
+---
+```
+
+### `toc`
+
+Controls whether the table of contents is displayed for the page. Set to `false` to hide the table
+of contents.
+
+```md
+---
+toc: false
+---
+```
+
+### `disable_pager`
+
+Controls whether the previous/next page navigation is displayed at the bottom of the page. Set to
+`true` to disable it.
+
+```md
+---
+disable_pager: true
+---
+```
+
+### `draft`
+
+Marks a document as a draft. Draft documents are only visible when running in development mode and
+are excluded from production builds. This is useful for working on content that isn't ready to be
+published.
+
+```md
+---
+draft: true
+---
+```
+
+:::info
+
+When `draft: true` is set:
+
+- The document will be visible when running `npx apitogo run`
+- The document will be excluded from builds created with `npx apitogo build`
+- The document won't appear in the navigation or be accessible via URL in production
+
+:::
+
+### `lastModifiedTime`
+
+The last modified timestamp for the page. This property is automatically set by APIToGo during the
+build process based on the Git commit history. You generally should not set this manually.
+
+If you need to override the automatically detected date, you can set it explicitly:
+
+```md
+---
+lastModifiedTime: 2025-11-20T10:30:00.000Z
+---
+```
+
+::if{mode=opensource}
+
+:::info
+
+For accurate last modified dates in deployment environments, ensure full Git history is available
+during builds. See the [Vercel deployment guide](/docs/deploy/vercel#accurate-last-modified-dates)
+for configuration details.
+
+:::
+
+::
+
+## Complete Example
+
+Here's an example showing multiple frontmatter properties used together:
+
+```md title=documentation.md
+---
+title: Advanced Configuration Guide
+description: Learn how to configure advanced features in APIToGo
+category: Configuration
+navigation_label: Advanced Config
+navigation_icon: settings
+toc: true
+disable_pager: false
+draft: false
+---
+
+This page content follows the frontmatter...
+```

package/docs/markdown/mdx.md

@@ -1,68 +1,68 @@
----
-title: MDX
-sidebar_icon: notebook-pen
-description:
-  Learn how to use MDX in APIToGo to create rich documentation pages with markdown and custom React
-  components.
----
-
-APIToGo supports MDX files for creating rich content pages. MDX is a markdown format that allows you
-to include JSX components in your markdown files.
-
-## Getting Started
-
-To use MDX in your documentation, simply create files with the `.mdx` extension instead of `.md`.
-These files work exactly like regular markdown files but with all MDX features unlocked - you can
-write normal markdown content and add JSX components whenever needed.
-
-```
-docs/
-├── my-page.md      # Regular markdown
-├── my-mdx-page.mdx # MDX with JSX support
-```
-
-## Custom Components
-
-APIToGo supports the use of custom components in your MDX files. This allows you to create reusable
-components that can be used across multiple pages.
-
-You can create a custom component in your project and reference it in the
-[APIToGo Configuration](./overview.md) file.
-
-For example, create the `<MyCustomComponent />` component in a file called `MyCustomComponent.tsx`
-in the `src` directory at the root of your project.
-
-```tsx
-export default function MyCustomComponent() {
-  return <div>My Custom Component</div>;
-}
-```
-
-In [APIToGo Configuration](./overview.md) you will need to import the component and add it to the
-`customComponents` option in the configuration.
-
-```ts title=config
-import MyCustomComponent from "./src/MyCustomComponent";
-
-const config: ApitogoConfig = {
-  // ...
-  mdx: {
-    components: {
-      MyCustomComponent,
-    },
-  },
-  // ...
-};
-
-export default config;
-```
-
-## JSX in Headings
-
-JSX components in headings render in both the sidebar navigation and table of contents:
-
-```mdx
-# My Page <Badge>New</Badge>
-```
-
-Components must be registered via [`mdx.components`](#custom-components) to work in headings.
+---
+title: MDX
+sidebar_icon: notebook-pen
+description:
+  Learn how to use MDX in APIToGo to create rich documentation pages with markdown and custom React
+  components.
+---
+
+APIToGo supports MDX files for creating rich content pages. MDX is a markdown format that allows you
+to include JSX components in your markdown files.
+
+## Getting Started
+
+To use MDX in your documentation, simply create files with the `.mdx` extension instead of `.md`.
+These files work exactly like regular markdown files but with all MDX features unlocked - you can
+write normal markdown content and add JSX components whenever needed.
+
+```
+docs/
+├── my-page.md      # Regular markdown
+├── my-mdx-page.mdx # MDX with JSX support
+```
+
+## Custom Components
+
+APIToGo supports the use of custom components in your MDX files. This allows you to create reusable
+components that can be used across multiple pages.
+
+You can create a custom component in your project and reference it in the
+[APIToGo Configuration](./overview.md) file.
+
+For example, create the `<MyCustomComponent />` component in a file called `MyCustomComponent.tsx`
+in the `src` directory at the root of your project.
+
+```tsx
+export default function MyCustomComponent() {
+  return <div>My Custom Component</div>;
+}
+```
+
+In [APIToGo Configuration](./overview.md) you will need to import the component and add it to the
+`customComponents` option in the configuration.
+
+```ts title=config
+import MyCustomComponent from "./src/MyCustomComponent";
+
+const config: ApitogoConfig = {
+  // ...
+  mdx: {
+    components: {
+      MyCustomComponent,
+    },
+  },
+  // ...
+};
+
+export default config;
+```
+
+## JSX in Headings
+
+JSX components in headings render in both the sidebar navigation and table of contents:
+
+```mdx
+# My Page <Badge>New</Badge>
+```
+
+Components must be registered via [`mdx.components`](#custom-components) to work in headings.