You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
// Update 'VARIANT' to pick a Node version: 18, 16, 14.
8
+
// Append -bullseye or -buster to pin to an OS version.
9
+
// Use -bullseye variants on local arm64/Apple Silicon.
10
+
"args": { "VARIANT": "16-bullseye" }
11
+
},
12
+
13
+
// Configure tool-specific properties.
14
+
"customizations": {
15
+
// Configure properties specific to VS Code.
16
+
"vscode": {
17
+
// Add the IDs of extensions you want installed when the container is created.
18
+
"extensions": [
19
+
"eamodio.gitlens",
20
+
"yzhang.markdown-all-in-one",
21
+
"philipbe.theme-gray-matter",
22
+
"bierner.markdown-preview-github-styles",
23
+
"xabikos.JavaScriptSnippets",
24
+
"dbaeumer.vscode-eslint",
25
+
"drKnoxy.eslint-disable-snippets",
26
+
"esbenp.prettier-vscode",
27
+
"stylelint.vscode-stylelint",
28
+
"jock.svg",
29
+
"gencer.html-slim-scss-css-class-completion",
30
+
"syler.sass-indented",
31
+
"christian-kohler.path-intellisense"
32
+
]
33
+
}
34
+
},
35
+
36
+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
37
+
"forwardPorts": [3000],
38
+
39
+
// Use 'postCreateCommand' to run commands after the container is created.
40
+
"postCreateCommand": "yarn && yarn prepare-data",
41
+
"postStartCommand": "echo 'Please read the README document at https://github.com/apache/apisix-website before using, developing, or encountering problems.'",
42
+
43
+
// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
Copy file name to clipboardexpand all lines: README.md
+38-12
Original file line number
Diff line number
Diff line change
@@ -13,15 +13,13 @@ A cloud-native microservices API Gateway
13
13
14
14
<br>
15
15
16
-
## Usage
16
+
## Getting Started
17
17
18
18
> If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first.
19
19
20
20
### Pre-requisites
21
21
22
-
First, you need to install `Node.js`, `Yarn`, `Git`.
23
-
24
-
Since the installation method may change, we recommend that you check the installation method on the corresponding official website. If you encounter any problems, please feel free to create an issue.
22
+
First, you need to install **Git**.
25
23
26
24
Then you should fork this repo, and clone your fork:
If you are using **VS Code**, **Docker**, and **Remote - Containers** plugin, you can use this to get started quickly.
40
+
41
+
> No, but want to try this way? Please read [Developing inside a Container#Installation](https://code.visualstudio.com/docs/remote/containers#_installation).
42
+
43
+
Then, start **VS Code**, run the `Remote-Containers: Open Folder in Container...` command.
44
+
45
+
> **Tip:** For details on how to do this, see the documentation [Developing inside a Container#Quick Start](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-an-existing-folder-in-a-container).
46
+
47
+
After the initialization, you can skip the preparation part of the commands below and read [the rest](#previewing-documents-developing) directly.
48
+
49
+
### Getting started in the conventional way
50
+
51
+
First, you need to install **Node.js**, **Yarn**.
52
+
53
+
> **Tip:** Since the installation method may change, we recommend that you check the installation method on the corresponding official website. If you encounter any problems, please feel free to create an issue.
54
+
55
+
Then you can read [the commands](#commands) below.
56
+
57
+
## Commands
40
58
41
59
When you find that some commands do not run, or cannot be found, look at the package.json file.
42
60
43
-
This may be because the project is being updated quickly, but there is no time to make updates to the relevant documentation.
61
+
This may be because the project is being updated quickly, but the corresponding developer did not find the time to update the corresponding documentation.
44
62
45
-
####Preparation
63
+
### Preparation
46
64
47
65
Except for the following commands that you need to run after downloading the project for the first time, you can **try running them again** when you encounter any problems.
48
66
49
67
```sh
50
68
# 1. Install deps
51
69
yarn
52
70
53
-
# 2. Prepare necessory data
71
+
# 2. Prepare necessary data
54
72
yarn prepare-data
55
73
56
74
# Tip.
@@ -61,7 +79,15 @@ yarn generate-repos-info # Generate repository information for each project
61
79
yarn generate-picked-posts # Generate frontmatter information for featured blogs
62
80
```
63
81
64
-
#### Preview documentation, Development
82
+
> If you get a 403 error `Rate Limit Exceeded` from GitHub, that means you have hit the GitHub API rate limit. the project needs your [personal access token](https://github.com/settings/tokens) to unlimit it.
83
+
>
84
+
> If you don't already have one, [create one](https://github.com/settings/tokens/new), and run below command in your terminal (no scope to your personal data is needed)
85
+
>
86
+
> ```bash
87
+
>export GITHUB_TOKEN=${your token}
88
+
>```
89
+
90
+
### Previewing documents, Developing
65
91
66
92
When you modify a document, blog, or page code, the preview in development mode is the fastest.
67
93
@@ -86,7 +112,7 @@ yarn start:blog:zh
86
112
yarn start:website
87
113
```
88
114
89
-
#### Build locally
115
+
###Building
90
116
91
117
When you want to build or preview a site that looks the same as it does online, run the following commands.
Next, you can modify the documentation or code, commit it and push it to GitHub when you're done. If you're not familiar with this, you can read [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) first.
113
139
114
-
###Advance
140
+
## Advance Guide
115
141
116
142
If you only want to modify the `*.md` files, the above guide may be sufficient.
117
143
118
144
But if you need to develop, please read the guide below.
0 commit comments