https://github.com/rinlit-233-shiroko/rinui-docs
The development documentation for RinUI, a Fluent Design-like Qt Quick (QML) UI library.
https://github.com/rinlit-233-shiroko/rinui-docs
docs documentation rinui vite vitepress website
Last synced: 8 months ago
JSON representation
The development documentation for RinUI, a Fluent Design-like Qt Quick (QML) UI library.
- Host: GitHub
- URL: https://github.com/rinlit-233-shiroko/rinui-docs
- Owner: RinLit-233-shiroko
- License: mit
- Created: 2025-04-11T18:19:35.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-26T15:50:58.000Z (about 1 year ago)
- Last Synced: 2025-07-22T01:51:11.631Z (11 months ago)
- Topics: docs, documentation, rinui, vite, vitepress, website
- Homepage: https://ui.rinlit.cn/
- Size: 2.22 MB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
RinUI Documentation
The development documentation for RinUI, a Fluent Design-like Qt Quick (QML) UI library.
**English**
> [!TIP]
> What is RinUI? Let's check [it](https://github.com/RinLit-233-shiroko/Rin-UI) out.
## 📄 Introduction
RinUI is a Fluent Design-like Qt Quick (QML) UI library.
[Learn More >](https://github.com/RinLit-233-shiroko/Rin-UI)
### Online Preview
You can view the documentation online [here](https://ui.rinlit.cn/).
## 🪄 Quick Start
1. Install Dependencies
```bash
npm install
```
2. Start the Dev server
```bash
npm run docs:dev
```
3. Open the browser and go to `http://localhost:5173/`
## 🙌 Acknowledgements
### Resources
- [VitePress](https://github.com/vuejs/vitepress)
### Contributors
Contributions are welcome!
Thanks to the great people who contributed to this project.
[](https://github.com/RinLit-233-shiroko/RinUI-docs/graphs/contributors)
## 📜 License
This project is licensed under the MIT License, you can learn more about it in the [license file](./LICENSE).
Copyright © 2025 RinLit
##
This is an experimental project by Rin as a newcomer. Welcome to suggest and contribute to this project. ❤️