@lukoweb/apitogo 0.2.56 → 0.2.57

package/docs/configuration/search.md

@@ -1,164 +0,0 @@
----
-title: Search
-sidebar_icon: search-code
-description:
-  Learn how to configure and customize search functionality in APIToGo, including setup instructions
-  for Pagefind and Inkeep providers, result transformation, and ranking options.
----
-
-APIToGo offers search functionality that enhances user experience by enabling content discovery
-across your site. When configured, a search bar will appear in the header, allowing users to quickly
-find relevant information on any page.
-
-We currently support three search providers:
-
-- [Pagefind](https://pagefind.app/)
-- [Algolia DocSearch](https://docsearch.algolia.com/)
-- [Inkeep](https://inkeep.com/)
-
-## Pagefind
-
-[Pagefind](https://pagefind.app/) is a lightweight, static search library that can be used to add
-search to your APIToGo site without any external services.
-
-To enable pagefind search, configure the `search` option in your configuration:
-
-```typescript
-{
-  search: {
-    type: "pagefind",
-    // Optional: Maximum number of sub results per page
-    maxSubResults: 3,
-    // Optional: Configure search result ranking (defaults shown below)
-    ranking: {
-      termFrequency: 0.8,
-      pageLength: 0.6,
-      termSimilarity: 1.2,
-      termSaturation: 1.2,
-    },
-  }
-}
-```
-
-### Transforming/Filtering Search Results
-
-You can transform or filter search results using the `transformResults` option. This function
-receives the search result along with the current auth state and context, allowing you to:
-
-- Filter results based on user permissions
-- Modify result content
-- Add custom results
-
-The type of `result` is the same as
-[the type returned by Pagefind's search API](https://github.com/Pagefind/pagefind/blob/03552d041d9533b09563f6c50466b25d394ece64/pagefind_web_js/types/index.d.ts#L123-L160).
-
-```typescript
-{
-  search: {
-    type: "pagefind",
-    transformResults: ({ result, auth, context }) => {
-      // Return false to filter out the result
-      if (!auth.isAuthenticated) return false;
-
-      // Return true or undefined to keep the original result
-      if (result.url.includes("/private/")) return true;
-
-      // Return a modified result
-      return {
-        ...result,
-        title: `${result.title} (${context.meta.title})`
-      };
-    }
-  }
-}
-```
-
-For more information about how Pagefind's ranking system works and how to customize it for your
-content, see the [Pagefind ranking documentation](https://pagefind.app/docs/ranking/).
-
-## Algolia DocSearch
-
-[Algolia DocSearch](https://docsearch.algolia.com/) is a free search solution for open-source
-documentation sites. You can apply for the free DocSearch program or use your own Algolia account.
-
-### Installation
-
-```bash
-npm install @zudoku/plugin-search-algolia
-```
-
-The published package name is still `@zudoku/plugin-search-algolia` (APIToGo Algolia search plugin).
-Add it via the `plugins` array in your site config.
-
-### Configuration
-
-```typescript
-import { algoliaSearchPlugin } from "@zudoku/plugin-search-algolia";
-
-export default {
-  plugins: [
-    algoliaSearchPlugin({
-      appId: "YOUR_APP_ID",
-      apiKey: "YOUR_SEARCH_API_KEY",
-      indices: ["YOUR_INDEX_NAME"],
-    }),
-  ],
-};
-```
-
-You can get your credentials by [applying for DocSearch](https://docsearch.algolia.com/apply/) or
-creating an index through the [Algolia dashboard](https://www.algolia.com/dashboard).
-
-Any additional [DocSearch options](https://docsearch.algolia.com/docs/api/) can be passed alongside
-the required fields.
-
-## Inkeep
-
-[Inkeep](https://inkeep.com/) is an AI-powered search and chat platform that can index your
-documentation and provide intelligent search capabilities to your users.
-
-### Setting up Inkeep Integration
-
-Before you can use Inkeep search in your APIToGo site, you need to set up an Inkeep integration and
-have your site indexed. Here's how to get started:
-
-#### 1. Create an Inkeep Account
-
-1. Go to [Inkeep](https://inkeep.com/) and sign up for an account
-2. Navigate to the [Inkeep Portal](https://portal.inkeep.com/)
-
-#### 2. Set up Site Indexing
-
-1. In the Inkeep Portal, create a new project or integration
-2. Configure your site URL so Inkeep can crawl and index your documentation
-3. Ensure your APIToGo site is deployed and publicly accessible for indexing
-4. Wait for Inkeep to crawl and index your site content (this may take some time)
-
-#### 3. Get Your Integration Credentials
-
-To add Inkeep search to your site you will need to copy some variables from your
-[Inkeep account setting](https://portal.inkeep.com/):
-
-- API Key
-- Integration ID
-- Organization ID
-
-#### 4. Configure APIToGo
-
-Once you have your credentials and your site is indexed, you can configure the `search` option in
-your [APIToGo Configuration](./overview.md):
-
-```typescript
-{
-  // ...
-  search: {
-    type: "inkeep",
-    apiKey: "<your-api-key>",
-    integrationId: "<your-integration-id>",
-    organizationId: "<your-organization-id>",
-    primaryBrandColor: "#26D6FF",
-    organizationDisplayName: "Your Organization Name",
-  }
-  // ...
-}
-```

package/docs/configuration/sentry.mdx

@@ -1,44 +0,0 @@
----
-sidebar_icon: bug
----
-
-# Sentry
-
-Sentry is a popular error tracking tool that helps you monitor and fix crashes in real time. It
-provides you with detailed error reports, so you can quickly identify and resolve issues before they
-affect your users.
-
-## Enable Sentry
-
-1. To enable it you have to first install the optional dependency `@sentry/react`.
-
-```bash
-npm install --save @sentry/react
-```
-
-2. And then set the `SENTRY_DSN` environment variable in your APIToGo project.
-
-```bash
-
-SENTRY_DSN=https://your-sentry-dsn
-```
-
-## Release management
-
-However this does not handle release management for you. For that you can
-[create a custom `vite.config.ts`](./vite-config) and use the `@sentry/vite-plugin` plugin.
-
-```ts
-import { sentryVitePlugin } from "@sentry/vite-plugin";
-import { defineConfig } from "vite";
-
-export default defineConfig({
-  plugins: [
-    sentryVitePlugin({
-      authToken: "your-token",
-      org: "your-org",
-      project: "your-project",
-    }),
-  ],
-});
-```

package/docs/configuration/site.md

@@ -1,124 +0,0 @@
----
-sidebar_label: Branding & Layout
-sidebar_icon: layout-dashboard
-description:
-  Customize your APIToGo site's branding, logo, banner, and layout options with detailed
-  configuration examples and guidance.
----
-
-# Branding & Layout
-
-We offer you to customize the main aspects of your APIToGo site's appearance and behavior.
-
-## Branding
-
-**Title**, **logo** can be configured in under the `site` property:
-
-```tsx title=config
-const config = {
-  site: {
-    title: "My API Documentation",
-    logo: {
-      src: {
-        light: "/path/to/light-logo.png",
-        dark: "/path/to/dark-logo.png",
-      },
-      alt: "Company Logo",
-      href: "/",
-    },
-    // Other options...
-  },
-};
-```
-
-### Available Options
-
-#### Title
-
-Set the title of your site next to the logo in the header:
-
-```tsx title=config
-{
-  site: {
-    title: "My API Documentation",
-  }
-}
-```
-
-#### Logo
-
-Configure the site's logo with different versions for light and dark themes:
-
-```tsx title=config
-{
-  site: {
-    logo: {
-      src: {
-        light: "/light-logo.png",
-        dark: "/dark-logo.png"
-      },
-      alt: "Company Logo",
-      width: "120px", // optional width
-      href: "/", // optional link target (defaults to "/")
-      reloadDocument: true, // optional, defaults to true
-    }
-  }
-}
-```
-
-The `reloadDocument` option controls whether clicking the logo triggers a full page reload (`true`,
-the default) or uses client-side SPA navigation (`false`). A full reload is useful when your landing
-page is served by a different system (e.g. a CMS) outside of APIToGo.
-
-#### Colors & Theme
-
-We allow you to fully customize all colors, borders, etc - read more about it in
-[Colors & Themes](/docs/customization/colors-theme)
-
-## Layout
-
-### Banner
-
-Add a banner message to the top of the page:
-
-```tsx title=config
-{
-  site: {
-    banner: {
-      message: "Welcome to our beta documentation!",
-      color: "info", // "note" | "tip" | "info" | "caution" | "danger" or custom
-      dismissible: true
-    }
-  }
-}
-```
-
-### Footer
-
-The footer configuration has its own dedicated section. See the [Footer Configuration](./footer) for
-details.
-
-## Complete Example
-
-Here's a comprehensive example showing all available page configuration options:
-
-```tsx title=config
-{
-  site: {
-    title: "My API Documentation",
-    logo: {
-      src: {
-        light: "/images/logo-light.svg",
-        dark: "/images/logo-dark.svg"
-      },
-      alt: "Company Logo",
-      width: "100px",
-    },
-    banner: {
-      message: "Welcome to our documentation!",
-      color: "info",
-      dismissible: true
-    },
-  }
-}
-```

package/docs/configuration/slots.mdx

@@ -1,125 +0,0 @@
----
-title: Slots
-sidebar_icon: between-horizontal-start
-description:
-  Learn how to use slots to inject custom content into predefined locations throughout your APIToGo
-  site.
----
-
-Slots provide a powerful way to inject custom content into predefined locations throughout APIToGo.
-They allow you to extend the default layout and functionality without modifying the core components.
-
-## Configuration
-
-You can define slots in your `apitogo.config.json` file using the `slots` property:
-
-```tsx
-import type { ApitogoConfig } from "@lukoweb/apitogo";
-import { Button } from "@lukoweb/apitogo/ui/Button.js";
-
-const config: ApitogoConfig = {
-  // ... other config
-  slots: {
-    "head-navigation-end": () => (
-      <div className="flex items-center gap-2">
-        <Button variant="ghost" size="icon" asChild>
-          <a href="https://github.com/your-repo">
-            <GithubIcon className="w-4 h-4" />
-          </a>
-        </Button>
-      </div>
-    ),
-    "footer-before": <div>Custom footer content</div>,
-  },
-};
-
-export default config;
-```
-
-## Slot Types
-
-Slots accept either:
-
-- **React components/elements**: JSX elements
-- **Function components**: Functions that return JSX elements and receive routing props
-
-```tsx
-slots: {
-  // JSX element
-  "footer-after": <CustomFooter />,
-
-  // Function with access to routing props
-  "head-navigation-end": ({ navigate, location, searchParams }) => (
-    <Button
-      onClick={() => navigate('/settings')}
-      variant={location.pathname === '/settings' ? 'default' : 'ghost'}
-    >
-      Settings
-    </Button>
-  ),
-}
-```
-
-Functions receive an object with routing properties:
-
-- `location` - Current route location
-- `navigate` - Navigation function
-- `searchParams` - URL search parameters
-- `setSearchParams` - Function to update search parameters
-- `params` - Route parameters
-
-## Type Safety
-
-APIToGo provides full TypeScript support for slot names. All predefined slot names will show up with
-autocomplete when you type them in your configuration.
-
-## Advanced Usage
-
-For more advanced slot usage, including programmatic slot management, dynamic content, and adding
-custom slot names, see the [Slot Component](/docs/components/slot) documentation.
-
-## Examples
-
-### Adding Social Links to Header
-
-```tsx
-slots: {
-  "head-navigation-end": () => (
-    <div className="flex items-center gap-2">
-      <Button variant="ghost" size="icon" asChild>
-        <a href="https://github.com/your-org" target="_blank">
-          <GithubIcon className="w-4 h-4" />
-        </a>
-      </Button>
-      <Button variant="ghost" size="icon" asChild>
-        <a href="https://discord.gg/your-server" target="_blank">
-          <DiscordIcon className="w-4 h-4" />
-        </a>
-      </Button>
-    </div>
-  ),
-}
-```
-
-### Dynamic Content with Routing
-
-```tsx
-slots: {
-  "top-navigation-side": ({ location, navigate }) => (
-    <div className="flex items-center gap-2">
-      <Button
-        variant={location.pathname === '/docs' ? 'default' : 'ghost'}
-        onClick={() => navigate('/docs')}
-      >
-        Documentation
-      </Button>
-      <Button
-        variant={location.pathname === '/api' ? 'default' : 'ghost'}
-        onClick={() => navigate('/api')}
-      >
-        API Reference
-      </Button>
-    </div>
-  ),
-}
-```

package/docs/configuration/vite-config.md

@@ -1,18 +0,0 @@
----
-title: Vite Config
-sidebar_icon: server-crash
----
-
-APIToGo is built on top of [Vite](https://vite.dev/) and can be customized using a
-[Vite configuration file](https://vite.dev/config/) if advanced functionality is required.
-
-Not all configurations are supported in APIToGo, but common tasks like adding plugins will generally
-work as expected. Simply create a `vite.config.ts` file in the root of your project and set the
-configuration options as needed.
-
-APIToGo will automatically pick up the configuration file and will use it to augment the built-in
-configuration.
-
-You can find an
-[example project](https://github.com/lukoweb/apitogo-doc-tool/tree/main/examples/with-vite-config)
-on GitHub that demonstrates how to use a custom Vite configuration with APIToGo.