更新说明文档

This commit is contained in:
LingASDJ 2023-04-11 09:39:58 +08:00
parent 5b955e69dd
commit 6af5f8bb5a
5 changed files with 146 additions and 23 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
node_modules

59
README.md Normal file
View File

@ -0,0 +1,59 @@
# RW-API-Code
[English Docs](README_en.md)
简单的代码,简单的学习。
基于VitePress框架的铁锈战争API代码。
在这里你可以研究RTS单元代码以及地图代码调试代码或更多
你准备好了吗?让我们开始吧
# 项目规则与说明
* 此代码仅供参考。如果有任何错误或遗漏请随时提及Github问题
* RW API Code是一个非官方的第三方RustedWarfare代码网站提供高效和高度学习的服务态度。
* 如果您想合作开发请Fork我们的主要分支机构并申请PullRecust
# 开发说明
## 1.前提条件Node.js 18或以上
```文本
如果你没有Node.js你可以从下面的链接下载。
什么我不确定Node.js是什么
我建议立即关闭这个页面。
```
Node.js链接[Node.js](https://nodejs.org/zh-cn)
## 2.安装Vite Press
```bash
npm i vitepress -D
```
## 3.Package.json框架结构
```json
{
"scripts": {
"docs:dev": "vitepress dev rustedwarfareapicode",
"docs:build": "vitepress build rustedwarfareapicode",
"docs:preview": "vitepress preview rustedwarfareapicode"
},
"devDependencies": {
"vitepress": "^1.0.0-alpha.65"
}
}
```
## 4.本地部署
开发测试:
```bash
npm run docs:dev
```
构建测试:
```bash
npm run docs:build
```
预览测试:
```bash
npm run docs:preview
```
# Netlify部署
当您提交PR时它会自动为您处理。
# 项目使用的许可证
[Apache许可证-2.0](https://github.com/LingASDJ/RW-API-Code/blob/main/LICENSE)

63
README_en.md Normal file
View File

@ -0,0 +1,63 @@
# RW-API-CODE
Easy Code,Easy Study.
Rusted Warfare API Code Base on VitePress Frame Work.
In this.You Can Study RTS Unit Code,And Map Code,Debug Code Or More And More,
Do you Ready? Let's Go!
# Rules
* The code is for reference only. If there are any errors or omissions, please feel free to mention Github Issues
* RW-API-Code is an unofficial third-party RustedWarfare code website that provides an efficient and highly learned service attitude.
* If you want to collaborate on development, please Fork our main branch and apply for PullRequst
# Dev
## 1.Prerequisite: Node.js 18 or above
```txt
If you don't have Node.js, you can download it from the link below.
What, I'm not sure what Node.js is doing? I suggest closing this page immediately.
```
Node.js Link:[Node.js](https://nodejs.org/en)
## 2.Install Vite Press
```bash
npm i vitepress -D
```
## 3.Package.json Framework
```json
{
"scripts": {
"docs:dev": "vitepress dev rustedwarfareapicode",
"docs:build": "vitepress build rustedwarfareapicode",
"docs:preview": "vitepress preview rustedwarfareapicode"
},
"devDependencies": {
"vitepress": "^1.0.0-alpha.65"
}
}
```
## 4.Local Deployment
DEV TEST:
```bash
npm run docs:dev
```
Build TEST:
```bash
npm run docs:build
```
Preview TEST:
```bash
npm run docs:preview
```
# Netlify Deployment
When you submit your PR, it will automatically process it for you.
# License
[Apache License-2.0](https://github.com/LingASDJ/RW-API-Code/blob/main/LICENSE)

View File

@ -1,25 +1,25 @@
// node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/index.js
import "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/fonts.css";
import "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/fonts.css";
// node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/without-fonts.js
import "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/vars.css";
import "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/base.css";
import "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/utils.css";
import "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/components/custom-block.css";
import "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/components/vp-code.css";
import "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/components/vp-code-group.css";
import "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/components/vp-doc.css";
import "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/components/vp-sponsor.css";
import VPBadge from "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPBadge.vue";
import Layout from "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/Layout.vue";
import { default as default2 } from "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPHomeHero.vue";
import { default as default3 } from "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPHomeFeatures.vue";
import { default as default4 } from "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPHomeSponsors.vue";
import { default as default5 } from "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPDocAsideSponsors.vue";
import { default as default6 } from "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPTeamPage.vue";
import { default as default7 } from "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPTeamPageTitle.vue";
import { default as default8 } from "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPTeamPageSection.vue";
import { default as default9 } from "D:/RW-API-Code/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPTeamMembers.vue";
import "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/vars.css";
import "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/base.css";
import "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/utils.css";
import "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/components/custom-block.css";
import "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/components/vp-code.css";
import "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/components/vp-code-group.css";
import "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/components/vp-doc.css";
import "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/styles/components/vp-sponsor.css";
import VPBadge from "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPBadge.vue";
import Layout from "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/Layout.vue";
import { default as default2 } from "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPHomeHero.vue";
import { default as default3 } from "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPHomeFeatures.vue";
import { default as default4 } from "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPHomeSponsors.vue";
import { default as default5 } from "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPDocAsideSponsors.vue";
import { default as default6 } from "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPTeamPage.vue";
import { default as default7 } from "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPTeamPageTitle.vue";
import { default as default8 } from "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPTeamPageSection.vue";
import { default as default9 } from "D:/RTS-Code-V4-Html/node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/components/VPTeamMembers.vue";
var theme = {
Layout,
enhanceApp: ({ app }) => {

View File

@ -1,17 +1,17 @@
{
"hash": "4dd20789",
"browserHash": "80372500",
"hash": "85f40fa2",
"browserHash": "3b680fcd",
"optimized": {
"vue": {
"src": "../../../../node_modules/_vue@3.2.47@vue/dist/vue.runtime.esm-bundler.js",
"file": "vue.js",
"fileHash": "4333e76b",
"fileHash": "01a01595",
"needsInterop": false
},
"@theme/index": {
"src": "../../../../node_modules/_vitepress@1.0.0-alpha.65@vitepress/dist/client/theme-default/index.js",
"file": "@theme_index.js",
"fileHash": "c2b7e6a4",
"fileHash": "e11163fd",
"needsInterop": false
}
},