https://github.com/raselshikdar/rs-log
A journal of ideas, by Rasel Shikdar built with VitePress
https://github.com/raselshikdar/rs-log
personal-blog sugarat-theme vitepress-blog
Last synced: 20 days ago
JSON representation
A journal of ideas, by Rasel Shikdar built with VitePress
- Host: GitHub
- URL: https://github.com/raselshikdar/rs-log
- Owner: raselshikdar
- Created: 2025-06-21T11:36:53.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-07-18T08:00:45.000Z (3 months ago)
- Last Synced: 2025-08-01T18:56:32.273Z (2 months ago)
- Topics: personal-blog, sugarat-theme, vitepress-blog
- Language: TypeScript
- Homepage: https://rasel.jsx.pm
- Size: 2.82 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
VitePress @sugarat/theme
A minimalist style VitePress blog theme demo project.
## Usage
First, install `pnpm`:
```sh
npm i -g pnpm
```
Install dependencies:
```sh
pnpm install
```
Start development:
```sh
pnpm dev
```
Build the project:
```sh
pnpm build
```
Preview the output:
```sh
pnpm serve
```
## GitHub Pages Deployment
① Enable GitHub Actions deployment for GitHub Pages:
② Copy the `.github/workflows/deploy.yml` file to the same directory in your project.
This file is already included in the demo project, so you can proceed directly to the next step.
③ Modify the build config in `docs/.vitepress/config.mts`.
**If your repository name is already set to `username.github.io`, you don’t need to change anything — keep the default base `/`.**
Otherwise, change `base` to `"/your-repo-name/"`. Example:
```ts
// Other unrelated code omitted
const base = '/vitepress-blog-sugar-template/'
export default defineConfig({
base,
})
```
④ Push to the `main` branch.
If additional adjustments are needed for deployment or build settings, refer to the `deploy.yml` file for more details.