https://github.com/unjs/undocs

Minimal Documentation theme and CLI for shared usage across UnJS projects.
https://github.com/unjs/undocs

Last synced: 3 months ago
JSON representation

Minimal Documentation theme and CLI for shared usage across UnJS projects.

• Host: GitHub
• URL: https://github.com/unjs/undocs
• Owner: unjs
• License: mit
• Created: 2024-01-12T10:52:48.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-08-16T02:41:49.000Z (3 months ago)
• Last Synced: 2024-08-17T01:16:47.906Z (3 months ago)
• Language: Vue
• Homepage: https://undocs.pages.dev/
• Size: 5.12 MB
• Stars: 160
• Watchers: 4
• Forks: 12
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# UnJS Docs

Minimal Documentation Theme and CLI for shared usage across UnJS projects.

> [!IMPORTANT]

> Undocs is currently intended for UnJS docs only and is not fully customizable yet. 


> Contributions are more than welcome but please consider that this project is not ready yet to be used. 


> Make sure to use [Bun](https://bun.sh/) and [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) for Windows.

> We don't guarantee stability yet and it is expected that it doesn't work time to time.

## Contribution

  Local development

- Clone this repository

- Install the latest LTS version of [Node.js](https://nodejs.org/en/)

- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`

- Install dependencies using `bun install`

- Run tests using `bun dev`

## License

Published under the [MIT](https://github.com/unjs/undocs/blob/main/LICENSE) license.

Made by [@pi0](https://github.com/pi0), [@atinux](https://github.com/atinux) and [community](https://github.com/unjs/undocs/graphs/contributors) 💛











---

_🤖 auto updated with [automd](https://automd.unjs.io)_