Skip to content

Commit

Permalink
docs: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Yue-plus committed Sep 1, 2024
1 parent d78820c commit c4a1668
Show file tree
Hide file tree
Showing 3 changed files with 162 additions and 176 deletions.
67 changes: 23 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,39 @@
# Astro Arknights

The project is under development... / 项目开发中……

[Live Demo / 在线演示](https://arknights.astro.yue.zone/)

## Astro Starter Kit: Basics

```sh
npm create astro@latest -- --template basics
```
[![CI](https://github.com/Yue-plus/astro-arknights/actions/workflows/deploy.yml/badge.svg)](https://github.com/Yue-plus/astro-arknights/actions/workflows/deploy.yml)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/Yue-plus/astro-arknights/blob/main/LICENSE)

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
The goal of [AstroArknights] is to build a fully-featured [Static Site Generator (SSG)](https://en.wikipedia.org/wiki/Static_site_generator) based on the [Astro](https://docs.astro.build/en/getting-started/) framework.
Its design pays homage to the official Simplified Chinese website of the mobile game [Arknights](https://ak.hypergryph.com/).

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
[AstroArknights] 的目标是基于 [Astro](https://docs.astro.build/zh-cn/getting-started/) 框架构建 *全特性* [静态网站生成器(<abbr title="Static Site Generator">SSG</abbr>)](https://en.wikipedia.org/wiki/Static_site_generator)
其设计致敬了 [明日方舟](https://ak.hypergryph.com/) 手游简中官方网站。

![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
The project is under development... / 项目开发中……

### 🚀 Project Structure
[Live Demo / 在线演示](https://arknights.astro.yue.zone/)

Inside of your Astro project, you'll see the following folders and files:
## Documentation - 文档

```text
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.json
```
[简体中文](https://arknights.astro.yue.zone/docs/)

Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
## Try Online - 在线尝试

There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/Yue-plus/astro-arknights)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/Yue-plus/astro-arknights)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Yue-plus/astro-arknights)

Any static assets, like images, can be placed in the `public/` directory.
## Try Localhost

### 🧞 Commands
```shell
git clone https://github.com/Yue-plus/astro-arknights.git --depth=1
cd astro-arknights
pnpm install
pnpm dev
```

All commands are run from the root of the project, from a terminal:
<http://localhost:4321>

| Command | Action |
|:--------------------------|:-------------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `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).
[AstroArknights]: https://github.com/Yue-plus/astro-arknights
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@
"@astrojs/react": "^3.6.2",
"@astrojs/tailwind": "^5.1.0",
"@nanostores/react": "^0.7.3",
"@types/react": "^18.3.4",
"@types/react": "^18.3.5",
"@types/react-dom": "^18.3.0",
"astro": "^4.15.1",
"nanostores": "^0.11.3",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"sass": "^1.77.8",
"swiper": "^11.1.11",
"swiper": "^11.1.12",
"tailwindcss": "^3.4.10",
"typescript": "^5.5.4"
}
Expand Down
Loading

0 comments on commit c4a1668

Please sign in to comment.