@lukoweb/apitogo 0.2.22 → 0.2.24

package/docs/deploy/apache-nginx.md

@@ -1,41 +1,41 @@
----
-title: Apache & Nginx
----
-
-APIToGo generates static HTML files for each page during build. Your server must be configured to
-serve these files correctly.
-
-## Apache
-
-Create a `.htaccess` file in your document root (alongside `index.html`):
-
-```apache
-RewriteEngine On
-
-RewriteCond %{REQUEST_FILENAME} !-f
-RewriteCond %{REQUEST_FILENAME}.html -f
-RewriteRule ^(.*)$ $1.html [L]
-
-RewriteCond %{REQUEST_FILENAME} !-f
-RewriteCond %{REQUEST_FILENAME} !-d
-RewriteRule ^ index.html [L]
-```
-
-Requires `mod_rewrite` enabled and `AllowOverride All` in your Apache configuration.
-
-## Nginx
-
-Add a `try_files` directive to your server block:
-
-```nginx
-server {
-    listen 80;
-    server_name example.com;
-    root /var/www/html;
-    index index.html;
-
-    location / {
-        try_files $uri $uri.html $uri/ /index.html;
-    }
-}
-```
+---
+title: Apache & Nginx
+---
+
+APIToGo generates static HTML files for each page during build. Your server must be configured to
+serve these files correctly.
+
+## Apache
+
+Create a `.htaccess` file in your document root (alongside `index.html`):
+
+```apache
+RewriteEngine On
+
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME}.html -f
+RewriteRule ^(.*)$ $1.html [L]
+
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule ^ index.html [L]
+```
+
+Requires `mod_rewrite` enabled and `AllowOverride All` in your Apache configuration.
+
+## Nginx
+
+Add a `try_files` directive to your server block:
+
+```nginx
+server {
+    listen 80;
+    server_name example.com;
+    root /var/www/html;
+    index index.html;
+
+    location / {
+        try_files $uri $uri.html $uri/ /index.html;
+    }
+}
+```

package/docs/deploy/apitogo.md

@@ -1,17 +1,17 @@
-# Deploy with APIToGo CLI
-
-Platform publish is **`npx apitogo deploy`** — the same engine as MCP `publish_dev_portal`.
-
-Full walkthrough (prerequisites, secrets, `--only`, status, teardown):
-
-→ **[Go live with CLI](../cli/go-live.md)**
-
-Quick reference:
-
-```bash
-export APITOGO_API_KEY_ID=apk_...
-export APITOGO_API_SECRET=...
-cd ./dev-portal
-npx apitogo deploy --platform-plan free
-npx apitogo status
-```
+# Deploy with APIToGo CLI
+
+Platform publish is **`npx apitogo deploy`** — the same engine as MCP `publish_dev_portal`.
+
+Full walkthrough (prerequisites, secrets, `--only`, status, teardown):
+
+→ **[Go live with CLI](../cli/go-live.md)**
+
+Quick reference:
+
+```bash
+export APITOGO_API_KEY_ID=apk_...
+export APITOGO_API_SECRET=...
+cd ./dev-portal
+npx apitogo deploy --platform-plan free
+npx apitogo status
+```

package/docs/deploy/cloudflare-pages.md

@@ -1,74 +1,74 @@
----
-title: Cloudflare Pages
----
-
-[Pages](https://developers.cloudflare.com/pages) is a low configuration way of publishing your
-documentation.
-
-## Prerequisites
-
-To publish your site to Cloudflare Pages you will need:
-
-- A Cloudflare account
-
-Optionally, you may also need:
-
-- A GitHub or GitLab account (optional)
-
-## Deploying to Pages
-
-Cloudflare offers three different ways to create Pages sites.
-
-1. Using the [Cloudflare CLI](https://developers.cloudflare.com/pages/get-started/c3/)
-2. Directly uploading the files using
-   [drag and drop](https://developers.cloudflare.com/pages/get-started/direct-upload/#drag-and-drop),
-   or their
-   [Wrangler CLI](https://developers.cloudflare.com/pages/get-started/direct-upload/#wrangler-cli)
-3. Integration with
-   [GitHub or GitLab](https://developers.cloudflare.com/pages/get-started/git-integration/)
-
-It's up to you which approach you choose but the fastest approach is to use the Wrangler CLI.
-
-## Deploy using Wrangler
-
-Wrangler makes light work of deploying to Cloudflare Pages, but first you need to get your files in
-order.
-
-Build the static version of your documentation site by running:
-
-```bash
-npm run build
-```
-
-This will generate a new folder called `dist` that contains all the files that you need to deploy.
-
-Next, if you don't already have one, create a new Pages project:
-
-```bash
-npx wrangler pages project create
-```
-
-Finally, deploy the files to the new project:
-
-```bash
-npx wrangler pages deploy ./dist
-```
-
-Within a few seconds the site will be live and viewable at `<your-project-name>.pages.dev`.
-
-## Accurate Last Modified Dates
-
-If you have enabled the [`showLastModified`](/docs/configuration/docs#showlastmodified) option,
-APIToGo automatically tracks the last modified date of your documentation pages using Git history.
-However, Cloudflare Pages performs shallow clones by default, which can result in inaccurate "Last
-Modified" dates for pages that haven't been updated recently.
-
-To ensure accurate last modified dates when using Git integration with Cloudflare Pages, modify your
-build command to fetch the full history before building:
-
-```bash
-git fetch --unshallow && npm run build
-```
-
-This command converts the shallow clone to a full clone before running your build, ensuring all
-pages show their correct last modified dates.
+---
+title: Cloudflare Pages
+---
+
+[Pages](https://developers.cloudflare.com/pages) is a low configuration way of publishing your
+documentation.
+
+## Prerequisites
+
+To publish your site to Cloudflare Pages you will need:
+
+- A Cloudflare account
+
+Optionally, you may also need:
+
+- A GitHub or GitLab account (optional)
+
+## Deploying to Pages
+
+Cloudflare offers three different ways to create Pages sites.
+
+1. Using the [Cloudflare CLI](https://developers.cloudflare.com/pages/get-started/c3/)
+2. Directly uploading the files using
+   [drag and drop](https://developers.cloudflare.com/pages/get-started/direct-upload/#drag-and-drop),
+   or their
+   [Wrangler CLI](https://developers.cloudflare.com/pages/get-started/direct-upload/#wrangler-cli)
+3. Integration with
+   [GitHub or GitLab](https://developers.cloudflare.com/pages/get-started/git-integration/)
+
+It's up to you which approach you choose but the fastest approach is to use the Wrangler CLI.
+
+## Deploy using Wrangler
+
+Wrangler makes light work of deploying to Cloudflare Pages, but first you need to get your files in
+order.
+
+Build the static version of your documentation site by running:
+
+```bash
+npm run build
+```
+
+This will generate a new folder called `dist` that contains all the files that you need to deploy.
+
+Next, if you don't already have one, create a new Pages project:
+
+```bash
+npx wrangler pages project create
+```
+
+Finally, deploy the files to the new project:
+
+```bash
+npx wrangler pages deploy ./dist
+```
+
+Within a few seconds the site will be live and viewable at `<your-project-name>.pages.dev`.
+
+## Accurate Last Modified Dates
+
+If you have enabled the [`showLastModified`](/docs/configuration/docs#showlastmodified) option,
+APIToGo automatically tracks the last modified date of your documentation pages using Git history.
+However, Cloudflare Pages performs shallow clones by default, which can result in inaccurate "Last
+Modified" dates for pages that haven't been updated recently.
+
+To ensure accurate last modified dates when using Git integration with Cloudflare Pages, modify your
+build command to fetch the full history before building:
+
+```bash
+git fetch --unshallow && npm run build
+```
+
+This command converts the shallow clone to a full clone before running your build, ensuring all
+pages show their correct last modified dates.

package/docs/deploy/direct-upload.md

@@ -1,17 +1,17 @@
----
-title: Upload/FTP
----
-
-APIToGo can produce a build of static HTML, JavaScript and CSS files that you can deploy directly to
-your own server.
-
-## Build locally
-
-To prepare the files you need to upload to your server, you will need to use the build command.
-
-```bash
-npm run build
-```
-
-Once complete, you will see a new `dist` folder in the root of your project that includes the files
-you need to upload.
+---
+title: Upload/FTP
+---
+
+APIToGo can produce a build of static HTML, JavaScript and CSS files that you can deploy directly to
+your own server.
+
+## Build locally
+
+To prepare the files you need to upload to your server, you will need to use the build command.
+
+```bash
+npm run build
+```
+
+Once complete, you will see a new `dist` folder in the root of your project that includes the files
+you need to upload.

package/docs/deploy/github-pages.md

@@ -1,49 +1,49 @@
----
-title: GitHub Pages
----
-
-[GitHub Pages](https://pages.github.com/) is a great way to publish your documentation, especially
-if you are using GitHub for source control.
-
-## Prerequisites
-
-To publish your site to GitHub Pages you will need:
-
-- A GitHub account
-
-## Deploying to GitHub Pages
-
-Use the
-[GitHub Actions Workflow](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow).
-
-You might need to configure the `basePath` in your site config.ts depending on how your site is
-hosted. For instance, if your site is available at username.github.io/your-repo/ you would set the
-`basePath` to `/your-repo`.
-
-```typescript
-import type { ApitogoConfig } from "@lukoweb/apitogo";
-
-const config: ApitogoConfig = {
-  basePath: "/your-repo",
-  //...
-};
-```
-
-## Accurate Last Modified Dates
-
-If you have enabled the [`showLastModified`](/docs/configuration/docs#showlastmodified) option,
-APIToGo automatically tracks the last modified date of your documentation pages using Git history.
-However, GitHub Actions performs shallow clones by default, which can result in inaccurate "Last
-Modified" dates for pages that haven't been updated recently.
-
-To ensure accurate last modified dates, configure the `actions/checkout` step to fetch the full
-history:
-
-```yaml
-- uses: actions/checkout@v4
-  with:
-    fetch-depth: 0 # Fetch all history for all branches and tags
-```
-
-For more details, see the
-[actions/checkout documentation](https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches).
+---
+title: GitHub Pages
+---
+
+[GitHub Pages](https://pages.github.com/) is a great way to publish your documentation, especially
+if you are using GitHub for source control.
+
+## Prerequisites
+
+To publish your site to GitHub Pages you will need:
+
+- A GitHub account
+
+## Deploying to GitHub Pages
+
+Use the
+[GitHub Actions Workflow](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow).
+
+You might need to configure the `basePath` in your site config.ts depending on how your site is
+hosted. For instance, if your site is available at username.github.io/your-repo/ you would set the
+`basePath` to `/your-repo`.
+
+```typescript
+import type { ApitogoConfig } from "@lukoweb/apitogo";
+
+const config: ApitogoConfig = {
+  basePath: "/your-repo",
+  //...
+};
+```
+
+## Accurate Last Modified Dates
+
+If you have enabled the [`showLastModified`](/docs/configuration/docs#showlastmodified) option,
+APIToGo automatically tracks the last modified date of your documentation pages using Git history.
+However, GitHub Actions performs shallow clones by default, which can result in inaccurate "Last
+Modified" dates for pages that haven't been updated recently.
+
+To ensure accurate last modified dates, configure the `actions/checkout` step to fetch the full
+history:
+
+```yaml
+- uses: actions/checkout@v4
+  with:
+    fetch-depth: 0 # Fetch all history for all branches and tags
+```
+
+For more details, see the
+[actions/checkout documentation](https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches).

package/docs/deploy/vercel.md

@@ -1,101 +1,101 @@
----
-title: Vercel
----
-
-[Vercel](https://vercel.com) offers multiple ways to deploy to its service, including via GitHub,
-and their CLI. You can read more about them in their
-[Deployments Overview](https://vercel.com/docs/deployments/overview).
-
-## Prerequisites
-
-To deploy to Vercel you will need:
-
-- A Vercel account (free)
-- A GitHub account (if deploying via GitHub)
-- The Vercel CLI
-
-Deploying your APIToGo powered documentation using the Vercel CLI is what we will cover in this
-guide.
-
-## Install the CLI
-
-To get started you need to install the CLI:
-
-```bash
-npm i -g vercel
-```
-
-## Setup a new project
-
-Next, set up a new Vercel project in the root of your docs:
-
-```bash
-vercel
-```
-
-This command will set up everything that is needed to deploy your documentation to Vercel.
-
-It will ask some specific questions including the project name and where the code is located. You
-can answer however you like for these.
-
-When you get to this step:
-
-```ansi
-No framework detected. Default Project Settings:
-- Build Command: `npm run vercel-build` or `npm run build`
-- Development Command: None
-- Install Command: `yarn install`, `pnpm install`, `npm install`, or `bun install`
-- Output Directory: `public` if it exists, or `.`
-? Want to modify these settings? (y/N)
-```
-
-Answer _Yes_ and select to modify the Output Directory.
-
-By default Vercel looks for a directory named `public`, but the APIToGo build will be found in
-`dist`. Set the output directory like this:
-
-```ansi
-? What's your Output Directory? dist
-```
-
-After this is complete, your site will build and Vercel will respond with the URL for you to test
-it.
-
-:::tip{title="Clean URLs"}
-
-You will almost certainly want to enable clean URLs for your site. This will remove the `.html`
-extension from your URLs. You can do this by adding a `cleanUrls` property to your `vercel.json`
-file. See the
-[Vercel Configuration](https://vercel.com/docs/projects/project-configuration#cleanurls) for more
-information.
-
-:::
-
-:::caution{title="Redirects"}
-
-If you have redirects in `apitogo.config.json`, you may also need matching entries in `vercel.json`.
-See the [Vercel Configuration](https://vercel.com/docs/projects/project-configuration#redirects) for
-more information.
-
-This is a current limitation. See [#115](https://github.com/lukoweb/apitogo-doc-tool/issues/151).
-
-:::
-
-## Accurate Last Modified Dates
-
-If you have enabled the [`showLastModified`](/docs/configuration/docs#showlastmodified) option,
-APIToGo automatically tracks the last modified date of your documentation pages using Git history.
-However, Vercel performs shallow clones by default (only fetching the last 10 commits), which can
-result in inaccurate "Last Modified" dates for pages that haven't been updated recently.
-
-To ensure accurate last modified dates, add the `VERCEL_DEEP_CLONE` environment variable to your
-Vercel project:
-
-1. Go to your project settings in Vercel
-2. Navigate to "Environment Variables"
-3. Add a new variable: `VERCEL_DEEP_CLONE=true`
-4. Save and redeploy your site
-
-This will enable full Git history during builds, ensuring all pages show their correct last modified
-dates. The impact on build time is minimal (typically 5-20 seconds on the first build), and
-subsequent builds benefit from caching.
+---
+title: Vercel
+---
+
+[Vercel](https://vercel.com) offers multiple ways to deploy to its service, including via GitHub,
+and their CLI. You can read more about them in their
+[Deployments Overview](https://vercel.com/docs/deployments/overview).
+
+## Prerequisites
+
+To deploy to Vercel you will need:
+
+- A Vercel account (free)
+- A GitHub account (if deploying via GitHub)
+- The Vercel CLI
+
+Deploying your APIToGo powered documentation using the Vercel CLI is what we will cover in this
+guide.
+
+## Install the CLI
+
+To get started you need to install the CLI:
+
+```bash
+npm i -g vercel
+```
+
+## Setup a new project
+
+Next, set up a new Vercel project in the root of your docs:
+
+```bash
+vercel
+```
+
+This command will set up everything that is needed to deploy your documentation to Vercel.
+
+It will ask some specific questions including the project name and where the code is located. You
+can answer however you like for these.
+
+When you get to this step:
+
+```ansi
+No framework detected. Default Project Settings:
+- Build Command: `npm run vercel-build` or `npm run build`
+- Development Command: None
+- Install Command: `yarn install`, `pnpm install`, `npm install`, or `bun install`
+- Output Directory: `public` if it exists, or `.`
+? Want to modify these settings? (y/N)
+```
+
+Answer _Yes_ and select to modify the Output Directory.
+
+By default Vercel looks for a directory named `public`, but the APIToGo build will be found in
+`dist`. Set the output directory like this:
+
+```ansi
+? What's your Output Directory? dist
+```
+
+After this is complete, your site will build and Vercel will respond with the URL for you to test
+it.
+
+:::tip{title="Clean URLs"}
+
+You will almost certainly want to enable clean URLs for your site. This will remove the `.html`
+extension from your URLs. You can do this by adding a `cleanUrls` property to your `vercel.json`
+file. See the
+[Vercel Configuration](https://vercel.com/docs/projects/project-configuration#cleanurls) for more
+information.
+
+:::
+
+:::caution{title="Redirects"}
+
+If you have redirects in `apitogo.config.json`, you may also need matching entries in `vercel.json`.
+See the [Vercel Configuration](https://vercel.com/docs/projects/project-configuration#redirects) for
+more information.
+
+This is a current limitation. See [#115](https://github.com/lukoweb/apitogo-doc-tool/issues/151).
+
+:::
+
+## Accurate Last Modified Dates
+
+If you have enabled the [`showLastModified`](/docs/configuration/docs#showlastmodified) option,
+APIToGo automatically tracks the last modified date of your documentation pages using Git history.
+However, Vercel performs shallow clones by default (only fetching the last 10 commits), which can
+result in inaccurate "Last Modified" dates for pages that haven't been updated recently.
+
+To ensure accurate last modified dates, add the `VERCEL_DEEP_CLONE` environment variable to your
+Vercel project:
+
+1. Go to your project settings in Vercel
+2. Navigate to "Environment Variables"
+3. Add a new variable: `VERCEL_DEEP_CLONE=true`
+4. Save and redeploy your site
+
+This will enable full Git history during builds, ensuring all pages show their correct last modified
+dates. The impact on build time is minimal (typically 5-20 seconds on the first build), and
+subsequent builds benefit from caching.

package/docs/deployment.md

@@ -1,9 +1,9 @@
-# Deployment
-
-| Path                           | Docs                                 |
-| ------------------------------ | ------------------------------------ |
-| **CLI** (`npx apitogo deploy`) | [Go live with CLI](./cli/go-live.md) |
-| **MCP / agents**               | [Go live](./mcp/go-live.md)          |
-
-Local-only builds: `npx apitogo build` (optional `--preview`). Platform publish is always
-`npx apitogo deploy`.
+# Deployment
+
+| Path                           | Docs                                 |
+| ------------------------------ | ------------------------------------ |
+| **CLI** (`npx apitogo deploy`) | [Go live with CLI](./cli/go-live.md) |
+| **MCP / agents**               | [Go live](./mcp/go-live.md)          |
+
+Local-only builds: `npx apitogo build` (optional `--preview`). Platform publish is always
+`npx apitogo deploy`.