https://github.com/guoyunhe/parcel-docs
Static document website generator powered by Parcel
https://github.com/guoyunhe/parcel-docs
Last synced: 4 months ago
JSON representation
Static document website generator powered by Parcel
- Host: GitHub
- URL: https://github.com/guoyunhe/parcel-docs
- Owner: guoyunhe
- License: mit
- Created: 2023-03-17T14:52:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-18T02:45:11.000Z (over 2 years ago)
- Last Synced: 2025-01-10T17:39:40.845Z (5 months ago)
- Language: TypeScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# parcel-docs
Static document website generator powered by Parcel.
```bash
npm i -D parcel parcel-docs react react-dom @mdx-js/react
```
```json
// package.json
{
"scripts": {
"start": "parcel-docs",
"build": "parcel build && parcel-docs build",
"watch": "parcel watch"
}
}
```
You can use parcel-docs with zero-configuration. However, you are allowed to configure quite a lot things.
```json
// .parceldocsrc
{
"docs": {
"title": "Foobar", // if not specified, use "name" from "package.json"
"description": "Foobar is foobar",
"copyright": {
"year": "2020-2023", // current year by default
"owner": "Guo Yunhe"
},
"github": "", // not necessary if you have specified GitHub repo in package.json
// if pages are not specified, all *.md files will be scanned and included in a flat structure
"pages": [
{
"path": "/",
"title": "Home",
"component": "README.md"
},
{
"path": "components",
"title": "Components", // a group, not clickable
"children": [
{
"path": "button",
"title": "Button",
"component": "src/components/button/index.md"
}
]
}
]
}
}
```