Skip to content

Instantly share code, notes, and snippets.

@mizchi
Last active June 19, 2025 13:43
Show Gist options
  • Save mizchi/ffbd52783e0d578625627560cefcf660 to your computer and use it in GitHub Desktop.
Save mizchi/ffbd52783e0d578625627560cefcf660 to your computer and use it in GitHub Desktop.
// pnpm add vitepress -D
// add this on docs/.vitepress/config.ts
// "doc:dev": "pnpm vitepress dev docs --port=9999",
// "doc:build": "pnpm vitepress build"
import { defineConfig } from "vitepress";
// Hyrum's Law: With a sufficient number of users of an API,
// it does not matter what you promise in the contract:
// all observable behaviors of your system will be depended on by somebody.
const PROJECT_NAME = "my-projcet"
export default defineConfig({
title: PROJECT_NAME,
description: "project-dercription",
base: "/",
head: [["link", { rel: "icon", href: "/favicon.ico" }]],
themeConfig: {
logo: "/logo.svg",
nav: [
{ text: "Home", link: "/" },
{ text: "Guide", link: "/guide/quick-start" },
{ text: "Commands", link: "/commands/" },
{ text: "GitHub", link: `https://github.com/mizchi/${PROJECT_NAME}` },
],
sidebar: [
{
text: "Guide",
items: [
{ text: "Quick Start", link: "/guide/quick-start" },
],
},
],
footer: {
message: "Released under the MIT License.",
copyright: "Copyright © 2025 mizchi",
},
search: {
provider: "local",
},
},
});
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment