diff --git a/README.md b/README.md index f4b8436..7161bc6 100644 --- a/README.md +++ b/README.md @@ -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) -``` - -The Separator is `|`, and the default mode is `big`. - -## ๐Ÿš€ 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 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 |