mirror of
https://github.com/ClovertaTheTrilobita/SanYeCao-blog.git
synced 2026-07-03 23:51:26 +00:00
99 lines
2.7 KiB
Markdown
99 lines
2.7 KiB
Markdown
# SanYeCao-Blog
|
||
<p align="right">[<a href="./README.md">中文</a> | <a href="./README-en.md">English</a>]</p>
|
||
<p align="center"><br>
|
||
✨SanYeCao Blog✨<br>
|
||
🌊Lightweight / Fast / Beautiful🌊<br><br>
|
||
Built With<br>
|
||
<img alt="Static Badge" src="https://img.shields.io/badge/Astro-6.0-purple">
|
||
<img alt="Static Badge" src="https://img.shields.io/badge/Nodejs-24-green">
|
||
<img alt="Static Badge" src="https://img.shields.io/badge/Heart-♥️-pink">
|
||
<br>
|
||
</p>
|
||
|
||
## 😋 Features
|
||
|
||
<br>
|
||
|
||
<p align="center">
|
||
<img
|
||
src="./docs/preview-en.png"
|
||
alt="preview-en"
|
||
style="max-width: 700px; width: 100%; height: auto;"
|
||
/>
|
||
</p>
|
||
|
||
<br>
|
||
|
||
- Built with purely static pages, responsive, lightweight, and visually pleasing
|
||
- Easy to use, with automatic deployment via GitHub Actions
|
||
- <del><i>Astro Is All You Need</i></del>
|
||
|
||
For more previews, please see: <b>[Images.md](docs/Images.md)</b>.
|
||
|
||
## 🧳 Usage
|
||
|
||
### 1. Fork this repository
|
||
|
||
<img width="294" height="155" alt="image" src="https://github.com/user-attachments/assets/6ffc9a32-c084-463f-8988-f7488baa44e0" />
|
||
|
||
Then clone it to your local machine.
|
||
|
||
### 2. Run / Build
|
||
|
||
> [!IMPORTANT]
|
||
>
|
||
> Before getting started, please <b>rename `.env.example` in the root directory to `.env` and configure the environment variables</b>, otherwise some features may not work properly.
|
||
|
||
For details about environment variables, see: <b>[EnvVariables-en.md](docs/EnvVariables-en.md)</b>
|
||
|
||
- Install dependencies
|
||
|
||
```shell
|
||
npm install
|
||
```
|
||
|
||
- Local development
|
||
|
||
```shell
|
||
npm run dev
|
||
```
|
||
|
||
- Local build
|
||
|
||
```shell
|
||
npm run build
|
||
```
|
||
|
||
### 3. Deployment
|
||
|
||
#### Deploy automatically with GitHub Actions
|
||
|
||
For details, see: <b>[GithubActions-en.md](docs/GithubActions-en.md)</b>.
|
||
|
||
#### Manual deployment
|
||
|
||
Upload the generated `dist/` directory to your server, and configure `NGINX` to point to `index.html`.
|
||
|
||
### 4. Comments
|
||
|
||
This project uses self-hosted <b>[Remark42](https://remark42.com/)</b> as its comment system.
|
||
|
||
For installation and deployment details, please refer to the official documentation: <b>[Installation | Remark42](https://remark42.com/docs/getting-started/installation/)</b>
|
||
|
||
<br>
|
||
|
||
### 5. Changelog
|
||
|
||
For details, see: <b>[ChangeLog-en.md](./docs/ChangeLog-en.md)</b>
|
||
|
||
### 6. Older Versions
|
||
|
||
Older versions of GISCUS are available on the <b>[deprecated/giscus](https://github.com/ClovertaTheTrilobita/SanYeCao-blog/tree/deprecated/giscus)</b> branch, but they haven’t been updated in a while and may contain numerous issues.
|
||
|
||
<hr>
|
||
|
||
## ⚖️ License
|
||
|
||
The source code in this repository is licensed under the `MIT License`.
|
||
|
||
Unless otherwise stated, all blog posts and other original non-code content in this repository are licensed under `CC BY-NC-ND 4.0`.
|