https://github.com/zl-asica/docs-suzublog
https://github.com/zl-asica/docs-suzublog
documentation suzu-blog vitepress
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/zl-asica/docs-suzublog
- Owner: ZL-Asica
- License: mit
- Created: 2024-10-23T04:38:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-16T16:11:00.000Z (over 1 year ago)
- Last Synced: 2025-03-25T19:11:29.235Z (over 1 year ago)
- Topics: documentation, suzu-blog, vitepress
- Language: JavaScript
- Homepage: https://suzu.zla.app
- Size: 1.02 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 📖 SuzuBlog Docs
[![GitHub License][license-badge]][license-link]
[![GitHub Release][release-badge]][release-link]
[![Node.js][node-badge]][node-link]
[![pnpm Version][pnpm-badge]][pnpm-link]
[![VitePress][vitepress-badge]][vitepress-link] |
[![Eslint][eslint-badge]][eslint-link]
[![Prettier][prettier-badge]][prettier-link]
> [Check out the documentation](https://suzu.zla.app/).
>
> [Check out a live demo (my personal blog)](https://www.zla.pub/).
>
> [Check out the source code](https://github.com/ZL-Asica/SuzuBlog).
Welcome to the official **SuzuBlog Documentation** repository! 🎉 This repo serves as the [VitePress](https://vitepress.dev/) base for SuzuBlog, providing clear and concise guides on setup, configuration, and customization.
## 📌 About
SuzuBlog is a minimalist, sakura-inspired blog template built with **Next.js**. This repository contains all the documentation needed to help you get started and make the most out of SuzuBlog.
## ✨ Contributing
We welcome contributions! If you’d like to improve the documentation, follow these steps:
1. **Fork** the repository.
2. **Make your edits** in a new branch.
3. **Submit a Pull Request** for review.
If you find any issues or have suggestions, feel free to [open an issue](https://github.com/ZL-Asica/docs-SuzuBlog/issues/new/choose).
## 📜 License
This documentation's code is licensed under the **MIT License**. See the [LICENSE](./LICENSE) file for details.
Contents of the documentation are licensed under the **CC BY 4.0 License**. See the [LICENSE-CC](./LICENSE-CC) file for details.
[eslint-badge]: https://img.shields.io/badge/eslint-4B32C3?logo=eslint&logoColor=white
[eslint-link]: https://www.npmjs.com/package/eslint-config-zl-asica
[license-badge]: https://img.shields.io/github/license/ZL-Asica/docs-SuzuBlog
[license-link]: https://github.com/ZL-Asica/docs-SuzuBlog/blob/main/LICENSE
[node-badge]: https://img.shields.io/badge/node%3E=18.18-339933?logo=node.js&logoColor=white
[node-link]: https://nodejs.org/
[pnpm-badge]: https://img.shields.io/github/package-json/packageManager/ZL-Asica/docs-SuzuBlog?label=&logo=pnpm&logoColor=fff&color=F69220
[pnpm-link]: https://pnpm.io/
[prettier-badge]: https://img.shields.io/badge/Prettier-F7B93E?logo=Prettier&logoColor=white
[prettier-link]: https://www.npmjs.com/package/@zl-asica/prettier-config
[release-badge]: https://img.shields.io/github/v/release/ZL-Asica/SuzuBlog?display_name=release&label=SuzuBlog&color=fc8da3
[release-link]: https://github.com/ZL-Asica/SuzuBlog/releases
[vitepress-badge]: https://img.shields.io/badge/VitePress-5468ff?logo=vite&logoColor=ffffff
[vitepress-link]: https://vitepress.dev/