apisix website

Site Apache Apisix®

O site da Apache Apisix®

Um gateway de API de microsserviços nativos da nuvem

Começando

Se você deseja escrever um blog ou corrigir alguns problemas relacionados ao blog, leia o guia contribuinte do Apache Apisix Blog primeiro.

Pré-requisitos

Primeiro, você precisa instalar o git .

Então você deve gastar este repositório e clonar o garfo:

 # 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

Introdução em um contêiner de dev

Se você estiver usando o Código VS , o Docker e o Plugin Remote - Contêineres , poderá usá -lo para começar rapidamente.

Não, mas quer tentar assim? Por favor, leia o desenvolvimento dentro de uma instalação de contêiner#.

Em seguida, inicie o código vs , execute os Remote-Containers: Open Folder in Container...

Dica: para obter detalhes sobre como fazer isso, consulte a documentação desenvolvendo dentro de um contêiner#Start Quick.

Após a inicialização, você pode pular a parte de preparação dos comandos abaixo e ler o restante diretamente.

Introdução da maneira convencional

Primeiro, você precisa instalar o node.js , fios .

Dica: como o método de instalação pode mudar, recomendamos que você verifique o método de instalação no site oficial correspondente. Se você encontrar algum problema, sinta -se à vontade para criar um problema.

Então você pode ler os comandos abaixo.

Comandos

Quando você achar que alguns comandos não são executados ou não podem ser encontrados, consulte o arquivo package.json.

Isso pode ocorrer porque o projeto está sendo atualizado rapidamente, mas o desenvolvedor correspondente não encontrou tempo para atualizar a documentação correspondente.

Preparação

Exceto pelos seguintes comandos que você precisa executar após o download do projeto pela primeira vez, você pode tentar executá -los novamente quando encontrar algum problema.

 # 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

Se você obtiver um Rate Limit Exceeded do GitHub, isso significa que você atingiu o limite da taxa de API do GitHub. O projeto precisa do seu token de acesso pessoal para ilimitá -lo.

Se você ainda não possui um, crie um e execute abaixo o comando no seu terminal (não é necessário escopo para seus dados pessoais)

 export GITHUB_TOKEN= ${your token}

Visualizar documentos, desenvolvendo

Quando você modifica um documento, blog ou código de página, a visualização no modo de desenvolvimento é a mais rápida.

 # 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

Prédio

Quando você deseja criar ou visualizar um site que pareça o mesmo que on -line, execute os seguintes comandos.

 # 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

Em seguida, você pode modificar a documentação ou código, compromete -o e empurrá -lo para o GitHub quando terminar. Se você não estiver familiarizado com isso, pode ler o fluxo do GitHub primeiro.

Guia antecipado

Se você deseja modificar apenas os arquivos *.md , o guia acima pode ser suficiente.

Mas se você precisar desenvolver, leia o guia abaixo.

Estrutura do projeto

Omitiu alguns documentos que podem não ser importantes.

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

Reconhecer

Agradecimentos especiais ao docusaurus.

Licença

Licença Apache 2.0