diff --git a/.github/workflows/readme-contributors.yml b/.github/workflows/readme-contributors.yml new file mode 100644 index 0000000..3f9f643 --- /dev/null +++ b/.github/workflows/readme-contributors.yml @@ -0,0 +1,21 @@ +name: Generate Contributors in README.md + +on: + push: + branches: + - main + +jobs: + contrib-readme-job: + runs-on: ubuntu-latest + name: A job to automate contrib in readme + permissions: + contents: write + pull-requests: write + steps: + - name: Contribute List + uses: akhilmhdh/contributors-readme-action@v2.3.10 + with: + image_size: 80 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/README.md b/README.md index e34a99b..7327205 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,218 @@ -# Astro Starter Kit: Minimal +# 齐鲁师范学院网络安全社团(QLNU-Sec-Team)官网 + +![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/QLNU-Sec-Team/QLNU-Sec-Team.github.io/astro.yml) +![GitHub License](https://img.shields.io/github/license/QLNU-Sec-Team/QLNU-Sec-Team.github.io) +![GitHub deployments](https://img.shields.io/github/deployments/QLNU-Sec-Team/QLNU-Sec-Team.github.io/github-pages) +![GitHub Release](https://img.shields.io/github/v/release/QLNU-Sec-Team/QLNU-Sec-Team.github.io) + +![NPM Version](https://img.shields.io/npm/v/astro) +![GitHub last commit](https://img.shields.io/github/last-commit/QLNU-Sec-Team/QLNU-Sec-Team.github.io) +![GitHub contributors](https://img.shields.io/github/contributors-anon/QLNU-Sec-Team/QLNU-Sec-Team.github.io) + + + + +运行在: https://www.qlnu-sec.cn + +## About + +> 本项目使用 `Astro` 作为 Web 框架进行编写 +> +> 基本框架由 [shenghuo2](https://github.com/shenghuo2) 进行编写实现 +> +> 于 2024.8.5 基本完成实现 + +## 维护提示 + +若需维护 `index`/`award` 页的内容 + +直接修改 `src/pages/index.md` / `src/pages/award.md` 即可 + +--- + +如需增加`member`页的成员 + +请修改`src/assets/memberList.json` + +按照以下格式编写 -```sh -npm create astro@latest -- --template minimal +``` +{ + "index": { + "level": "number", + "member": [ + "name" + ], + "link": { + "name": "https://link" + } + } +} ``` -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json) +--- -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +> 本项目使用了**ViewTransition**特性，所以请使用Astro ^4.12.2 +> +> 使用nodejs v20 -## 🚀 Project Structure -Inside of your Astro project, you'll see the following folders and files: +# 项目结构 -```text -/ -├── public/ -├── src/ -│ └── pages/ -│ └── index.astro -└── package.json ``` +. +├── public +│ ├── favicon.svg +│ ├── icon.png +│ ├── QLNU.png +│ └── wx.svg +├── src +│ ├── assets +│ │ └── memberList.json +│ ├── pages +│ │ ├── components +│ │ │ ├── footer.astro +│ │ │ ├── Navbar.astro +│ │ │ └── NavItem.astro +│ │ ├── layouts +│ │ │ ├── BaseLayout.astro +│ │ │ └── BaseMarkdownLayout.astro +│ │ ├── award.md +│ │ ├── index.md +│ │ └── member.astro +│ ├── styles +│ │ └── global.css +│ └── env.d.ts +├── astro.config.mjs +├── CNAME +├── LICENSE +├── package.json +├── package-lock.json +├── README.md +└── tsconfig.json + +``` + +## public + +此文件夹下为网站根目录可直接使用的文件 + +主要是存放非代码、未处理的资源 + +这个文件夹中的文件将会被原封不动地复制到构建文件夹中 + +`favicon.svg` 未使用，为Astro的icon + +## src + +### assets + +`memberList.json` 为 member.astro所引用的成员列表JSON + +结构请参考 [维护提示](#维护提示) + +### pages + +`Astro`将渲染在本文件夹下的文件为页面 + +### pages/components + +基本组件，Astro使用模块化设计 + +可以是 `Astro 组件` 或是像 React 或 Vue 这样的 `UI 框架组件` + +Navbar由NavItem组成 + +Footer为页脚 + +### pages/layouts + +框架模板，两个模板几乎相同，可以再进行合并重构 + +BaseLayout为原模板，后改为`member.astro`独用 + +BaseMarkdownLayout为`index.md`和`award.md`的渲染模板 + +### styles + +本文件夹下存放的`global.css`暂未实装 + +## 根目录 + +### package.json + +nodejs 项目清单 + +名称和版本 (name 和 version): 定义项目的名称和版本号。 + +描述 (description): 项目简要描述。 + +脚本 (scripts): 定义一组可以通过 `npm run