m1ngsama/FUJI
1
0
Fork 0
mirror of https://github.com/m1ngsama/FUJI.git synced 2025-12-24 10:51:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #44 from wen-templari/main

Browse source 
chore: update readme
This commit is contained in:
m1ng 2024-11-19 17:09:37 +08:00 committed by GitHub
commit 65d0d897ce
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

103
README.md
View file

@ -1,97 +1,16 @@
## 👏🏻 Introduction
# Home
This is a minimalist, beautiful, responsive blogging program written in Astro.
Home page for NBTCA.
## Preview
[https://astro-blog.qum.cc/](https://astro-blog.qum.cc/)
### Home
![首页](https://cos.lookcos.cn/blog/static/images/preview/preview_index.png)
### Dark mode
![文章黑暗模式](https://cos.lookcos.cn/blog/static/images/preview/preview_dark.png?)
### Normal article
![普通文章模式](https://cos.lookcos.cn/blog/static/images/preview/preview_light.png)
### Syntax highlighting
![Syntax](https://cos.lookcos.cn/blog/static/images/preview/preview_syntaxHighlighting.png)
### Three display model of images
![](https://cos.lookcos.cn/blog/static/images/preview/preview_different_mode.png)
The three display modes of images are: `wide`, `big`, `inline`.
When you edit your markdown file, you can add `wide` or `big` or `inline` to the image alt, like this:
```markdown
![alt content|wide](a.png)
```
<strong>The Separator is `|`, and the default mode is `big`.</strong>
## 🚀 Project Structure
In this Astro project, you'll see the following folders and files:
```
|-- README.md
|-- astro.config.mjs
|-- package.json
|-- public
| |-- favicon.svg
| `-- static
|-- src
| |-- components
| | |-- BaseHead.astro // common <head> tags
| | |-- Footer.astro
| | |-- Header.astro
| | `-- Navigation.astro
| |-- consts.js
| |-- env.d.ts
| |-- layouts
| | |-- BaseLayout.astro
| | |-- MarkdownPost.astro
| | |-- MoreTile.astro
| | `-- Tile.astro
| |-- pages
| | |-- about.astro
| | |-- archive.astro
| | |-- index.astro
| | |-- posts
| | | |-- some markdown post.md // 这里写文章
| | |-- rss.xml.js // RSS feed
| | `-- tags
| | `-- [tag].astro // dynamic route of all posts with a given tag
| |-- styles
| | `-- global.css // global styles
| `-- utils.js
```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the `public/` directory.
## 🧞 Commands
## Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
| Command | Action |
| :---------------------- | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm run dev` | Starts local dev server |
| `pnpm run build` | Build your production site to `./dist/` |
| `pnpm run preview` | Preview your build locally, before deploying |
| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm run astro --help` | Get help using the Astro CLI |