Add all config options commented out to the vocs template #278

roninjin10 · 2025-03-25T03:30:50Z

roninjin10
Mar 25, 2025
Sponsor

What

Add all options to vocs config commented out. This means when npx vocs init is run it generates this file

import { defineConfig } from 'vocs'

export default defineConfig({
  title: 'Docs',
  sidebar: [
    {
      text: 'Getting Started',
      link: '/getting-started',
    },
    {
      text: 'Example',
      link: '/example',
    },
  ],

  // aiCta: false,
  // ──────────────────────────────────────────────
  // Whether or not to show the AI call-to-action dropdown (e.g. "Open in ChatGPT").
  // Can also be set as an object with a custom query function.
  // Example:
  // aiCta: {
  //   query({ location }) {
  //     return `Please research and analyze this page: ${location} so I can ask you questions about it.`
  //   }
  // },

  // banner: 'Head to our new [Discord](https://discord.gg/JUrRkGweXV)!',
  // ──────────────────────────────────────────────
  // Configuration for a banner fixed to the top of the page.
  // Can be a Markdown string, a React element, or an object with properties such as:
  //   - dismissable: Whether the banner can be dismissed.
  //   - backgroundColor: The background color.
  //   - content: The content of the banner.
  //   - height: The height.
  //   - textColor: The text color.
  // Example as an object:
  // banner: {
  //   dismissable: false,
  //   backgroundColor: 'red',
  //   content: 'Head to our new [Discord](https://discord.gg/JUrRkGweXV)!',
  //   height: '28px',
  //   textColor: 'white',
  // },

  // basePath: '/docs',
  // ──────────────────────────────────────────────
  // The base path where the documentation will be deployed.
  // Useful for deploying to GitHub Pages or a subdirectory.

  // baseUrl: 'https://vocs.dev',
  // ──────────────────────────────────────────────
  // The base URL for your documentation. This populates the <base> tag in the HTML
  // and is used to form the dynamic OG image URL.

  // blogDir: './pages/blog',
  // ──────────────────────────────────────────────
  // Path to the blog pages relative to the project root.
  // Adjust this if you store your blog posts elsewhere.

  // description: 'Build reliable apps & libraries with lightweight, composable, and type-safe modules.',
  // ──────────────────────────────────────────────
  // A general description for your documentation.

  // editLink: {
  //   pattern: 'https://github.com/yourrepo/yourproject/edit/main/site/pages/:path',
  //   text: 'Edit on GitHub'
  // },
  // ──────────────────────────────────────────────
  // The editLink configuration defines where users are directed to edit the documentation.
  // "pattern" is the URL template and "text" is the anchor text for the edit link.

  // font: {
  //   google: 'Inter',
  //   // Optionally, specify a font for inline code and code blocks:
  //   // mono: { google: 'Dancing Script' },
  // },
  // ──────────────────────────────────────────────
  // Font configuration. Only Google Fonts are supported at the moment.
  // "google" sets the base font and "mono" can be used for monospaced fonts in code.

  // head: (
  //   <>
  //     <meta property="og:type" content="website" />
  //     <meta property="og:title" content="Docs" />
  //     <meta property="og:image" content="https://example.com/og-image.png" />
  //     <meta property="og:url" content="https://example.com" />
  //     <meta property="og:description" content="Description of your docs." />
  //   </>
  // ),
  // ──────────────────────────────────────────────
  // Additional tags to include in the <head> of your HTML document.
  // Can be provided as a React element, an object, or a function returning a React element.

  // iconUrl: '/icon.svg',
  // ──────────────────────────────────────────────
  // The URL for your site's favicon.
  // Can also be an object with separate URLs for light and dark modes.

  // logoUrl: '/logo.svg',
  // ──────────────────────────────────────────────
  // The URL for the logo used in the sidebar and mobile top nav header.
  // Can also be an object with separate URLs for light and dark modes.

  // markdown: {
  //   code: {
  //     themes: {
  //       light: 'github-light',
  //       dark: 'github-dark'
  //     }
  //   },
  //   remarkPlugins: [
  //     // Add any remark plugins here, e.g., remarkMath
  //   ],
  //   rehypePlugins: [
  //     // Add any rehype plugins here, e.g., rehype-slots
  //   ],
  // },
  // ──────────────────────────────────────────────
  // Markdown configuration including code syntax highlighting themes and plugins
  // for transforming Markdown and HTML.

  // ogImageUrl: 'https://vocs.dev/api/og?logo=%logo&title=%title&description=%description',
  // ──────────────────────────────────────────────
  // The OG Image URL used for social sharing.
  // Can also be an object with different URLs based on the current path.

  // rootDir: 'docs',
  // ──────────────────────────────────────────────
  // The root directory for your documentation. This can be an absolute path or
  // a path relative to the config file location.

  // search: {
  //   boostDocument(documentId) {
  //     return documentId === '/core' ? 2 : 1
  //   }
  // },
  // ──────────────────────────────────────────────
  // Search configuration that accepts MiniSearch options.
  // "boostDocument" is an example function to boost specific documents.

  // socials: [
  //   { icon: 'github', link: 'https://github.com/yourrepo' },
  //   { icon: 'x', link: 'https://twitter.com/yourhandle' }
  // ],
  // ──────────────────────────────────────────────
  // Social links displayed in the top navigation.
  // Supported icons include Discord, GitHub, Telegram, X (formerly Twitter), and Warpcast.

  // sponsors: [
  //   {
  //     name: 'Collaborator',
  //     height: 120,
  //     items: [
  //       [
  //         {
  //           name: 'Paradigm',
  //           link: 'https://paradigm.xyz',
  //           image: 'https://example.com/paradigm-light.svg',
  //         },
  //       ],
  //     ],
  //   },
  //   {
  //     name: 'Large Enterprise',
  //     height: 60,
  //     items: [
  //       [
  //         {
  //           name: 'WalletConnect',
  //           link: 'https://walletconnect.com',
  //           image: 'https://example.com/walletconnect-light.svg',
  //         },
  //         {
  //           name: 'Stripe',
  //           link: 'https://www.stripe.com',
  //           image: 'https://example.com/stripe-light.svg',
  //         },
  //       ],
  //     ],
  //   },
  // ],
  // ──────────────────────────────────────────────
  // Sponsors configuration to display sponsors in your documentation.
  // Each sponsor set can have a name, height, and a nested array of sponsor items.

  // theme: {
  //   accentColor: '#ff0000',
  //   variables: {
  //     color: {
  //       background: {
  //         light: 'white',
  //         dark: 'black'
  //       }
  //     }
  //   }
  // },
  // ──────────────────────────────────────────────
  // Theme configuration for customizing the look of your documentation.
  // "accentColor" and "variables" allow you to customize color schemes.

  // titleTemplate: '%s – Docs',
  // ──────────────────────────────────────────────
  // Template for the page title. "%s" will be replaced by the current page title.

  // topNav: [
  //   { text: 'Guide & API', link: '/getting-started', match: '/docs' },
  //   { text: 'Blog', link: '/blog' }
  // ],
  // ──────────────────────────────────────────────
  // Top navigation configuration. This is used to display links at the top of your site.

  // twoslash: {
  //   compilerOptions: {
  //     strict: true,
  //   }
  // },
  // ──────────────────────────────────────────────
  // TwoSlash configuration for enhanced code block support.
  // Allows you to pass custom TypeScript compiler options.

  // vite: {
  //   build: {
  //     minify: 'terser'
  //   },
  //   plugins: [
  //     // Add additional Vite plugins here (e.g., tsconfigPaths())
  //   ]
  // },
  // ──────────────────────────────────────────────
  // Vite configuration that will be merged with Vocs's default Vite config.
})

Why

It's just super convenient and easy to delete all the options if you don't want them there

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add all config options commented out to the vocs template #278

Uh oh!

{{title}}

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

Uh oh!

Add all config options commented out to the vocs template #278

Uh oh!

roninjin10 Mar 25, 2025 Sponsor

What

Why

Replies: 0 comments

roninjin10
Mar 25, 2025
Sponsor