apisix website 다운로드 apisix website 소스 코드 다운로드

apisix website

웹사이트 데이터

1.0.0

다운로드

Apache Apisix® 웹 사이트

클라우드 네이티브 마이크로 서비스 API 게이트웨이

시작하기

블로그를 작성하거나 블로그 관련 문제를 해결하려면 Apache Apisix 블로그 기여 가이드를 먼저 읽으십시오.

사전 반품

먼저 Git을 설치해야합니다.

그런 다음이 repo를 포크하고 포크를 복제해야합니다.

 # clone your fork repo
git clone [email protected]: ${your GitHub name} /apisix-website.git

# add this repo as upstream
git remote add upstream https://github.com/apache/apisix-website.git

# default dir should be apisix-website
cd apisix-website

개발자 컨테이너에서 시작합니다

VS Code , Docker 및 Remote -Containers 플러그인을 사용하는 경우이를 사용하여 신속하게 시작할 수 있습니다.

아니요,하지만 이런 식으로 시도하고 싶습니까? 컨테이너#설치 내부에서 개발을 읽으십시오.

그런 다음 시작 대 코드를 시작하고 Remote-Containers: Open Folder in Container... 명령을 실행합니다.

팁 : 이 작업을 수행하는 방법에 대한 자세한 내용은 컨테이너#빠른 시작 내부에서 개발되는 문서를 참조하십시오.

초기화 후 아래 명령의 준비 부분을 건너 뛰고 나머지를 직접 읽을 수 있습니다.

기존의 방식으로 시작합니다

먼저 Node.js , Yarn을 설치해야합니다.

팁 : 설치 방법이 변경 될 수 있으므로 해당 공식 웹 사이트에서 설치 방법을 확인하는 것이 좋습니다. 문제가 발생하면 자유롭게 문제를 일으키십시오.

그런 다음 아래 명령을 읽을 수 있습니다.

명령

일부 명령이 실행되지 않거나 찾을 수없는 경우 package.json 파일을보십시오.

프로젝트가 빠르게 업데이트되고 있기 때문에 해당 개발자가 해당 문서를 업데이트 할 시간을 찾지 못했기 때문일 수 있습니다.

준비

프로젝트를 처음으로 다운로드 한 후 실행 해야하는 다음 명령을 제외하고는 문제가 발생할 때 다시 실행해 보십시오.

 # 1. Install deps
yarn

# 2. Prepare necessary data
yarn prepare-data

# Tip.
# The `yarn prepare-data` command contains the following three commands
# If necessary, you can run any of the following commands individually
yarn sync-doc # Sync all project documents
yarn generate-repos-info # Generate repository information for each project
yarn generate-picked-posts # Generate frontmatter information for featured blogs

403 오류율 Rate Limit Exceeded 하는 경우 GitHub API 비율 제한에 도달했음을 의미합니다. 이 프로젝트에는 개인 액세스 토큰이 필요합니다.
아직 하나가없는 경우, 하나를 만들고 터미널에서 아래 명령을 실행하십시오 (개인 데이터에 대한 범위가 필요하지 않음).
 export GITHUB_TOKEN= ${your token}

문서 미리보기, 개발

문서, 블로그 또는 페이지 코드를 수정하면 개발 모드의 미리보기가 가장 빠릅니다.

 # Start docs part
yarn start:doc

# Tip.
# in dev, only English docs will be built
# it's a feature of docusaurus
# if you want to specify the locale,
# for example, Chinese, your should run
yarn start:doc --locale zh

# Start English Blog
yarn start:blog:en

# Start Chinese Blog
yarn start:blog:zh

# Start general docs, other pages part
yarn start:website

건물

온라인과 동일하게 보이는 사이트를 빌드하거나 미리 보려면 다음 명령을 실행하십시오.

 # Since the local environment is slightly different from the online one,
# you must add the environment variable `preview`
preview=true yarn build
# or
yarn build:preview

# The above commands only build the site,
# to preview it locally you need the following commands
yarn serve

# You can also build and preview each part individually,
# just like in development mode
preview=true yarn build:doc && yarn serve:doc
preview=true yarn build:blog:en && yarn serve:blog:en
preview=true yarn build:blog:zh && yarn serve:blog:zh
preview=true yarn build:website && yarn serve:website

다음으로 문서 나 코드를 수정하고 커밋하여 완료되면 GitHub로 푸시 할 수 있습니다. 이것에 익숙하지 않으면 먼저 Github Flow를 읽을 수 있습니다.

사전 가이드

*.md 파일 만 수정하려면 위 안내서로 충분할 수 있습니다.

그러나 개발 해야하는 경우 아래 가이드를 읽으십시오.

프로젝트 구조

중요하지 않은 일부 문서를 생략했습니다.

apisix-website
├── .github
│   └── workflows # for GitHub CI, with steps to actually build the site
├── .husky # git hooks, currently only pre-commit is used
├── scripts # scripts to help build the site
├── blog
│   ├── en
│   └── zh
├── config
├── doc
└── website
    ├── articles
    ├── docs
    │   └── general # https://apisix.apache.org/docs/general/join
    ├── i18n
    │   └── zh # chinese content
    │       ├── docusaurus-plugin-content-blog # blog
    │       ├── docusaurus-plugin-content-docs # general
    │       └── docusaurus-theme-classic # translations of navbar and footer
    ├── src
    │   ├── clientModules # docusaurus feature
    │   ├── hooks # react hooks
    │   ├── pages
    │   ├── shaders
    │   └── theme # swizzled any Docs/Blog component
    ├── static
    └── docusaurus.config.js