39 lines
No EOL
2.1 KiB
Markdown
39 lines
No EOL
2.1 KiB
Markdown
<div align="center">
|
|
<br />
|
|
<p>
|
|
<a href="https://os.prozilla.dev/"><img src="https://os.prozilla.dev/assets/logo.svg?v=2" height="200" alt="ProzillaOS" /></a>
|
|
</p>
|
|
<p>
|
|
<a href="https://github.com/prozilla-os/ProzillaOS/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/github/license/Prozilla/ProzillaOS?style=flat-square&color=FF4D5B&label=License"></a>
|
|
<a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Stars" src="https://img.shields.io/github/stars/Prozilla/ProzillaOS?style=flat-square&color=FED24C&label=%E2%AD%90"></a>
|
|
<a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Forks" src="https://img.shields.io/github/forks/Prozilla/ProzillaOS?style=flat-square&color=4D9CFF&label=Forks&logo=github"></a>
|
|
<a href="https://www.npmjs.com/package/prozilla-os"><img alt="NPM Version" src="https://img.shields.io/npm/v/prozilla-os?logo=npm&style=flat-square&label=prozilla-os&color=FF4D5B"></a>
|
|
</p>
|
|
</div>
|
|
|
|
## About
|
|
|
|
**🔗 [os.prozilla.dev/docs](https://os.prozilla.dev/docs)**
|
|
|
|
`@prozilla-os/docs` is a VitePress website that contains the documentation for ProzillaOS.
|
|
|
|
## Scripts
|
|
|
|
| Script | Description |
|
|
| --- | --- |
|
|
| <pre>pnpm run start</pre> | Start VitePress dev server at [localhost:3000](http://localhost:3000/). Changes to module will dynamically be hot-reloaded, so normally there is no need for hard-refreshes.
|
|
| <pre>pnpm run build</pre> | Compile project using VitePress and output to the `dist` directory.
|
|
| <pre>pnpm run preview</pre> | Start web server with preview of build at [localhost:8080](http://localhost:8080/). Can be useful for validating build before deploying.
|
|
| <pre>pnpm run generate</pre> | Generate basic information files in JSON format to use as a base for writing the documentation and output to the `data` directory.
|
|
|
|
## Links
|
|
|
|
- [Website][website]
|
|
- [GitHub][github]
|
|
- [Discord][discord]
|
|
- [Ko-fi][ko-fi]
|
|
|
|
[website]: https://os.prozilla.dev/docs
|
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/demo
|
|
[discord]: https://discord.gg/JwbyQP4tdz
|
|
[ko-fi]: https://ko-fi.com/prozilla |