https://github.com/pleaseai/docs
https://github.com/pleaseai/docs
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pleaseai/docs
- Owner: pleaseai
- Created: 2025-11-27T04:00:17.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-12-23T03:29:51.000Z (6 months ago)
- Last Synced: 2025-12-23T22:47:53.029Z (6 months ago)
- Language: Vue
- Homepage: https://docs-please.pages.dev
- Size: 22.5 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docs-please
A documentation system using **shadcn-vue** + **Nuxt Content**, inspired by Docus.
## Installation
```bash
npm install docs-please
```
```ts
// nuxt.config.ts
export default defineNuxtConfig({
extends: ['docs-please']
})
```
## Features
- shadcn-vue UI components (Button, Separator, etc.)
- Tailwind CSS v4 with CSS variables (oklch colors)
- Documentation layout with sidebar navigation
- Table of contents
- Dark/Light mode
- Mobile responsive
## Packages
| Package | Description |
|---------|-------------|
| `docs-please` | Nuxt layer for documentation sites |
| `@pleaseai/docs-site` | Example documentation site |
## Development
```bash
# Install dependencies
bun install
# Run development server
bun dev
# Lint
bun lint
bun lint:fix
# Type check
bun typecheck
```
## Architecture
```
docs/
├── packages/
│ └── layer/ # docs-please
│ ├── app/ # Vue components, layouts, pages
│ ├── modules/ # Nuxt modules (config, css)
│ └── ...
├── apps/
│ └── docs/ # Example documentation site
└── ref/ # Reference projects (git submodules)
├── docus/
├── shadcn-vue/
└── fumadocs/
```
## License
MIT