reonokiy/blog
1
0
Fork 0
mirror of https://github.com/reonokiy/blog.nokiy.net.git synced 2025-06-15 19:22:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update detailed usage documentation in readme

Browse source 
- update footnotes style
- update theme guides
This commit is contained in:
radishzzz 2025-04-13 23:33:30 +01:00
parent 5f95201576
commit 21d502b8d0
9 changed files with 116 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -47,24 +47,34 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram
<a>
</p>
## Deploy
## Usage
1. Click [`Fork`](https://github.com/radishzzz/astro-theme-retypeset/fork) to clone this repository.
1. [`Fork`](https://github.com/radishzzz/astro-theme-retypeset/fork) this repository, or use this template to create a new repository.
2. Click `Deploy to Netlify` or `Deploy to Vercel` below
2. In your forked repository, click the `Code` button, copy the `HTTPS` repository URL, and run the following commands in your terminal:
&emsp;[![Deploy to Netlify](assets/deploy-netlify.svg)](https://app.netlify.com/start)
[![Deploy to Vercel](assets/deploy-vercel.svg)](https://vercel.com/new)
```bash
# Clone the remote repository to your local machine
git clone <repository-url>
3. Select the repository and click `Deploy`.
# Navigate to the repository directory
cd <repository-name>
For other platforms, please refer to the [Astro Deployment Guides](https://docs.astro.build/en/guides/deploy/).
# Install pnpm globally (if not already installed)
npm install -g pnpm
## Updates
# Install project dependencies
pnpm install
1. Follow the [GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) to run `Sync fork`.
# Start the local development server
pnpm dev
```
2. Do not click `Discard Changes`.
3. Open [http://localhost:4321/](http://localhost:4321/) in your browser to preview the theme in real-time.
4. Modify the theme configuration file [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts) to customize your blog.
5. Commit and push your changes to the remote repository.
## Documentation
@ -72,6 +82,34 @@ For other platforms, please refer to the [Astro Deployment Guides](https://docs.
- [Markdown Style Guide](https://retypeset.radishzz.cc/en/posts/markdown-style-guide/)
- [Theme Color Schemes](https://retypeset.radishzz.cc/en/posts/theme-color-schemes/)
## Deploy
1. Click `Deploy to Netlify` or `Deploy to Vercel` below.
[![Deploy to Netlify](assets/deploy-netlify.svg)](https://app.netlify.com/start)
[![Deploy to Vercel](assets/deploy-vercel.svg)](https://vercel.com/new)
1. Follow the instructions, select your repository, and click `Deploy` to start deployment.
2. For other platforms, please refer to the [Astro Deployment Guides](https://docs.astro.build/en/guides/deploy/).
## Updates
Retypeset releases new features and bug fixes from time to time. You can 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 forked repository to synchronize with the latest branch. Be careful not to click `Discard Changes`, or you will lose your modifications.
## Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :--------------------- | :----------------------------------------------- |
| `pnpm install` | Install project dependencies |
| `pnpm dev` | Starts local dev server at `localhost:4321` |
| `pnpm build` | Build your production site to `./dist/` |
| `pnpm preview` | Preview your build locally, before deploying |
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm astro -- --help` | Get help using the Astro CLI |
## Credits
- [Typography](https://github.com/moeyua/astro-theme-typography)
@ -83,6 +121,8 @@ For other platforms, please refer to the [Astro Deployment Guides](https://docs.
## Star History
Thank you to everyone who has starred this project. Your support motivates me to keep maintaining it!
<p align="center">
<a href="https://star-history.com/#radishzzz/astro-theme-retypeset&Date">
<picture>