eddiesigner/bold-docs

Bold Theme Documentation

Bold Docs

Bold Theme Documentation powered by VitePress.

Prerequisites

• Node.js version 18 or higher.
• Terminal for accessing VitePress via its command line interface (CLI).
• Text Editor with Markdown syntax support.
  • VSCode is recommended, along with the official Vue extension.

Setup

Install dependencies by running:

npm install

Up and Running

The following npm scripts are available:

{
  "scripts": {
    "docs:dev": "vitepress dev",
    "docs:build": "vitepress build",
    "docs:preview": "vitepress preview"
  },
}

Development

The docs:dev script will start a local dev server with instant hot updates. Run it with the following command:

npm run docs:dev

The dev server should be running at http://localhost:5173. Visit the URL in your browser to see your new site in action!

Build and Test Locally

1. Run this command to build the docs:

npm run docs:build

2. Once built, preview it locally by running:

npm run docs:preview

The preview command will boot up a local static web server that will serve the output directory .vitepress/dist at http://localhost:4173. You can use this to make sure everything looks good before pushing to production.