docs: update readme

This commit is contained in:
radishzzz 2025-05-16 22:57:37 +01:00
parent 55923f9fcc
commit 157c171d97
2 changed files with 10 additions and 28 deletions

View file

@ -42,7 +42,6 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram
## Performance
<br>
<p align="center">
<a href="https://pagespeed.web.dev/analysis?url=https%3A%2F%2Fretypeset.radishzz.cc%2Fen%2F">
<img width="710" alt="Retypeset Lighthouse Score" src="images/retypeset-lighthouse-score.svg">
@ -52,15 +51,13 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram
## Getting Started
1. [Fork](https://github.com/radishzzz/astro-theme-retypeset/fork) this repository, or use this template to create a new repository.
2. Click the `Code` button, copy the `HTTPS` URL, and run the following commands in your terminal:
2. Run the following commands in your terminal:
```bash
# Clone the repository
git clone repository-url
git clone <repository-url>
# Navigate to the project directory
cd repository-name
cd <repository-name>
# Install pnpm globally (if not already installed)
npm install -g pnpm
@ -71,12 +68,8 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram
# Start the development server
pnpm dev
```
3. Open [localhost:4321](http://localhost:4321/) in your browser to see a live preview of your website.
4. Refer to the [Theme Guide](https://retypeset.radishzz.cc/en/posts/theme-guide/) to customize your blog and create new articles.
5. Refer to the [Astro Deployment Guides](https://docs.astro.build/en/guides/deploy/) to deploy your blog to Netlify, Vercel, or other platforms.
3. Refer to the [Theme Guide](https://retypeset.radishzz.cc/en/posts/theme-guide/) to customize your blog and create new articles.
4. Refer to the [Astro Deployment Guides](https://docs.astro.build/en/guides/deploy/) to deploy your blog to Netlify, Vercel, or other platforms.
&emsp;[![Deploy to Netlify](images/deploy-netlify.svg)](https://app.netlify.com/start)
[![Deploy to Vercel](images/deploy-vercel.svg)](https://vercel.com/new)
@ -84,9 +77,7 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram
## Updates
- Retypeset releases [new features](https://github.com/radishzzz/astro-theme-retypeset/issues/18) from time to time, which can be updated as follows.
- Refer to the [GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) to run `Sync fork` in your repository to sync with the latest branch.
- Do not click `Discard Changes`, or you will lose your modifications.
## Credits