apisix websiteダウンロード-Apisix apisix websiteソースコードのダウンロード

apisix website

ウェブサイトデータ

1.0.0

ダウンロード

ApacheApisix®ウェブサイト

ApacheApisix®のWebサイト

クラウドネイティブマイクロサービスAPIゲートウェイ

はじめる

ブログを作成したり、ブログ関連の問題を修正したい場合は、最初にApache Apisix Blog Contributing Guideをお読みください。

前提条件

まず、 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 、およびリモートコンテナプラグインを使用している場合、これを使用してすぐに開始できます。

いいえ、でもこのように試してみませんか？コンテナ＃インストール内の開発をお読みください。

次に、 vsコードを開始し、 Remote-Containers: Open Folder in Container...コマンドを実行します。

ヒント：これを行う方法の詳細については、コンテナ内で開発されているドキュメント＃クイックスタートを参照してください。

初期化の後、以下のコマンドの準備部分をスキップして、残りを直接読むことができます。

従来の方法で始めます

まず、 node.js 、 yarnをインストールする必要があります。

ヒント：インストール方法が変更される可能性があるため、対応する公式Webサイトでインストール方法を確認することをお勧めします。問題が発生した場合は、お気軽に問題を作成してください。

次に、以下のコマンドを読むことができます。

コマンド

一部のコマンドが実行されないか、見つからないことがわかった場合は、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

GitHubから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