mirror of https://github.com/testthedocs/awesome-docs.git synced 2026-07-18 07:12:09 -05:00

Files

sven 872b3e7404 Setup VitePress documentation with pnpm

- Added VitePress as dev dependency
- Created docs directory structure
- Configured VitePress with navigation and sidebar
- Added example pages (home, guide, installation)
- Updated package.json with docs scripts
- Added VitePress-specific entries to .gitignore
- Created setup documentation

2025-11-01 09:36:55 +01:00

1001 B

Raw Blame History

Installation

Learn how to install and set up this documentation site.

Prerequisites

Before you begin, ensure you have the following installed:

Node.js (version 16 or higher)
pnpm package manager

Installation Steps

Clone the repository

git clone https://github.com/testthedocs/awesome-docs.git
cd awesome-docs

Install dependencies
```
pnpm install
```
Start the development server
```
pnpm docs:dev
```
Build for production
```
pnpm docs:build
```

Verification

After installation, you should be able to access the documentation at http://localhost:5173 when running the development server.

Troubleshooting

If you encounter issues:

Ensure you're using Node.js version 16 or higher
Clear the node_modules and try reinstalling: rm -rf node_modules pnpm-lock.yaml && pnpm install
Check that all dependencies are properly installed

1001 B Raw Blame History