apisix website

Сайт Apache Apisix®

Сайт Apache Apisix®

Облачный шлюз микросервисов API

Начиная

Если вы хотите написать блог или исправить некоторые проблемы, связанные с блогом, сначала прочитайте руководство по блогу Apache Apisix.

Предварительные условия

Во -первых, вам нужно установить git .

Тогда вам следует расколоть это репо и клонировать свою вилку:

 # 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 -код , Docker и Pult -Containers Plugin, вы можете использовать его, чтобы начать быстро.

Нет, но хотите попробовать? Пожалуйста, прочитайте разработку внутри установки контейнера#.

Затем, запустите код , запустите Remote-Containers: Open Folder in Container... Команда.

Совет: Подробнее о том, как это сделать, см. Документацию, разрабатывающую в контейнере#Quick Start.

После инициализации вы можете пропустить приготовленную часть приведенных ниже команд и прямо прочитать остальные.

Начало работы обычным способом

Во -первых, вам нужно установить node.js , пряжа .

Совет: Поскольку метод установки может измениться, мы рекомендуем проверить метод установки на соответствующем официальном веб -сайте. Если вы столкнетесь с какими -либо проблемами, пожалуйста, не стесняйтесь создавать проблему.

Затем вы можете прочитать команды ниже.

Команды

Когда вы обнаружите, что некоторые команды не запускаются или не могут быть найдены, посмотрите на файл 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

Если вы получите Rate Limit Exceeded GitHub, это означает, что вы достигли ограничения ставки 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.

Предварительный гид

Если вы хотите только изменить файлы *.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

Сознавать

Особая благодарность Docusaurus.

Лицензия

Apache License 2.0