Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 4 additions & 166 deletions docs/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ import { defineConfig } from "@solidjs/start/config";
import arraybuffer from "vite-plugin-arraybuffer";

import { createWithSolidBase, defineTheme } from "../src/config";
import defaultTheme from "../src/default-theme";
import { SidebarConfig, createFilesystemSidebar } from "../src/config/sidebar";
import defaultTheme, { DefaultThemeSidebarItem } from "../src/default-theme";

const theme = defineTheme({
componentsPath: import.meta.resolve("./src/solidbase-theme"),
Expand Down Expand Up @@ -97,171 +98,8 @@ export default defineConfig(
},
],
sidebar: {
"/guide": [
{
title: "Overview",
collapsed: false,
items: [
{
title: "What is SolidBase?",
link: "/",
},
{
title: "Quick Start",
link: "/quickstart",
status: "new",
},
{
title: "Add to an Existing Project",
link: "/add-to-existing",
},
{
title: "Configure Your App",
link: "/config",
},
{
title: "Project Structure",
link: "/structure",
},
{
title: "Deploy Your Site",
link: "/deploy",
},
],
},
{
title: "Features",
collapsed: false,
items: [
{
title: "Markdown Extensions",
link: "/markdown",
},
{
title: "Language Switcher",
link: "/language-switcher",
},
{
title: "Internationalisation",
link: "/i18n",
},
{
title: "Sitemap Generation",
link: "/sitemap",
},
{
title: "Dev",
link: "/dev",
},
],
},
{
title: "Customisation",
collapsed: false,
items: [
{
title: "Custom Themes",
link: "/custom-themes",
},
{
title: "Extending Themes",
link: "/extending-themes",
},
],
},
],
"/reference": [
{
title: "Reference",
collapsed: false,
items: [
{
title: "Configuration Options",
link: "/config",
},
{
title: "Frontmatter Config",
link: "/frontmatter",
},
{
title: "Runtime API",
link: "/runtime-api",
},
],
},
{
title: "Default Theme",
collapsed: false,
items: [
{
title: "Overview",
link: "/default-theme",
},
{
title: "CSS Variables",
link: "/default-theme/css-variables",
},
{
title: "Components",
collapsed: false,
items: [
{
title: "Article",
link: "/default-theme/article",
},
{
title: "Features",
link: "/default-theme/features",
},
{
title: "Footer",
link: "/default-theme/footer",
},
{
title: "Header",
link: "/default-theme/header",
},
{
title: "Hero",
link: "/default-theme/hero",
},
{
title: "Last Updated",
link: "/default-theme/last-updated",
},
{
title: "Link",
link: "/default-theme/link",
},
{
title: "Locale Selector",
link: "/default-theme/locale-selector",
},
{
title: "Sidebar",
link: "/default-theme/sidebar",
},
{
title: "Table of Contents",
link: "/default-theme/toc",
},
{
title: "Theme Selector",
link: "/default-theme/theme-selector",
},
],
},
{
title: "Landing",
link: "/default-theme/landing",
},
{
title: "Layout",
link: "/default-theme/layout",
},
],
},
],
"/guide": createFilesystemSidebar("/guide"),
"/reference": createFilesystemSidebar("/reference"),
},
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ nav: [
The sidebar configuration allows you to create a structured sidebar navigation for different sections of your documentation, with support for collapsible groups and nested items. The value is an array, each containing a title, a collapsed state, and an array of items. Each item can have a title, link, and optional status (`"new"`, `"updated"`, `"next"`).

:::note
While there are preset statuses available, you can create your own custom status styles.
While there are preset statuses available, you can create your own custom status styles.

```ts title="app.config.ts"
// ..
Expand Down Expand Up @@ -293,20 +293,3 @@ sidebar: {
},
// ..
```

#### Search

SolidBase includes built-in search functionality. At the moment, it supports [Algolia DocSearch](https://docsearch.algolia.com/). You can configure the search provider and its options using the `search` option within `themeConfig`.

```ts title="app.config.ts"
// ..
search: {
provider: "algolia",
options: {
appID: "<YOUR_APP_ID>",
apiKey: "<YOUR_API_KEY>"
indexName: "<YOUR_INDEX_NAME>"
}
}
// ..
```
7 changes: 7 additions & 0 deletions docs/src/routes/guide/(4)deploy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Deploy
---

# {frontmatter.title}

A SolidBase app can be deployed anywhere a SolidStart app can be deployed. You can use [Nitro](https://nitro.build/deploy) in your `app.config.ts` to add presets to deploy your app to various platforms.
3 changes: 2 additions & 1 deletion docs/src/routes/guide/dave.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: What are we missing?
excludeFromSidebar: true
---

# Day 1088 of asking for an internal shitpost channel
# Day 1 of asking for solidconf

[[toc]]
8 changes: 0 additions & 8 deletions docs/src/routes/guide/deploy.mdx

This file was deleted.

Loading