apisix website Download - apisix website -Quellcode herunterladen

apisix website

Website-Daten

1.0.0

Herunterladen

Apache Apisix® -Website

Die Website von Apache Apisix®

Ein Cloud-nativer Microservices-API-Gateway

Erste Schritte

Wenn Sie ein Blog schreiben oder einige Probleme im Zusammenhang mit Blogs beheben möchten, lesen Sie zuerst Apache APISIX Blog, beitragen.

Voraussetzungen

Zuerst müssen Sie Git installieren.

Dann sollten Sie dieses Repo aufgeben und Ihre Gabel klonen:

 # 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

Erste Schritte in einem Entwicklerbehälter

Wenn Sie VS -Code , Docker und Remote -Container -Plugin verwenden, können Sie dies verwenden, um schnell loszulegen.

Nein, aber wollen Sie es so versuchen? Bitte lesen Sie die Entwicklung in einer Container#Installation.

Starten Sie dann vs Code , führen Sie die Remote-Containers: Open Folder in Container...

Tipp: Weitere Informationen dazu finden Sie in der Dokumentation, die sich in einem schnellen Start in Container#entwickelt.

Nach der Initialisierung können Sie den Vorbereitungsteil der folgenden Befehle überspringen und den Rest direkt lesen.

Erste Schritte auf konventionelle Weise

Zuerst müssen Sie Node.js , Garn installieren.

Tipp: Da sich die Installationsmethode ändern kann, empfehlen wir Ihnen, die Installationsmethode auf der entsprechenden offiziellen Website zu überprüfen. Wenn Sie auf Probleme stoßen, können Sie bitte ein Problem erstellen.

Dann können Sie die folgenden Befehle lesen.

Befehle

Wenn Sie feststellen, dass einige Befehle nicht ausgeführt werden oder nicht gefunden werden können, sehen Sie sich die Datei package.json an.

Dies kann daran liegen, dass das Projekt schnell aktualisiert wird, der entsprechende Entwickler jedoch nicht die Zeit fand, die entsprechende Dokumentation zu aktualisieren.

Vorbereitung

Mit Ausnahme der folgenden Befehle, die Sie nach dem Herunterladen des Projekts zum ersten Mal ausführen müssen, können Sie es erneut ausführen, wenn Sie auf Probleme stoßen.

 # 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

Wenn Sie eine 403 Rate Limit Exceeded , bedeutet dies, dass Sie die GitHub -API -Rate -Grenze erreicht haben. Das Projekt benötigt Ihr persönlicher Zugangs -Token, um es zu unbegrenzt.
Wenn Sie noch keinen haben, erstellen Sie einen und führen Sie den Befehl unten in Ihrem Terminal aus (es ist kein Umfang für Ihre persönlichen Daten erforderlich).
 export GITHUB_TOKEN= ${your token}

Vorschau auf Dokumente, Entwicklung

Wenn Sie ein Dokument, einen Blog oder einen Seitencode ändern, ist die Vorschau im Entwicklungsmodus am schnellsten.

 # 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

Gebäude

Wenn Sie eine Website erstellen oder eine Vorschau erstellen möchten, die genauso aussieht wie online, führen Sie die folgenden Befehle aus.

 # 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

Als nächstes können Sie die Dokumentation oder den Code ändern, sie festlegen und nach Abschluss nach GitHub weitergeben. Wenn Sie damit nicht vertraut sind, können Sie zuerst Github Flow lesen.

Vorabhandbuch

Wenn Sie nur die *.md -Dateien ändern möchten, kann die obige Anleitung ausreichen.

Wenn Sie sich jedoch entwickeln müssen, lesen Sie bitte die Anleitung unten.

Projektstruktur

Ließ einige Dokumente aus, die möglicherweise nicht wichtig sind.

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