apisix website

Situs web Apache Apisix®

Situs web Apache Apisix®

Gateway API Microservices-Native-Native

Memulai

Jika Anda ingin menulis blog atau memperbaiki beberapa masalah terkait blog, silakan baca panduan berkontribusi blog Apache Apisix terlebih dahulu.

Prasyarat

Pertama, Anda perlu menginstal git .

Maka Anda harus membayar repo ini, dan mengkloning garpu Anda:

 # 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

Memulai dalam wadah dev

Jika Anda menggunakan VS Code , Docker , dan Remote - Containers Plugin, Anda dapat menggunakannya untuk memulai dengan cepat.

Tidak, tapi ingin mencoba dengan cara ini? Harap baca pengembangan di dalam instalasi Container#.

Kemudian, Mulai VS Code , jalankan perintah Remote-Containers: Open Folder in Container...

Kiat: Untuk detail tentang cara melakukan ini, lihat dokumentasi yang dikembangkan di dalam wadah#Start Quick.

Setelah inisialisasi, Anda dapat melewatkan bagian persiapan dari perintah di bawah ini dan membaca sisanya secara langsung.

Memulai dengan cara konvensional

Pertama, Anda perlu menginstal node.js , benang .

Kiat: Karena metode instalasi dapat berubah, kami sarankan Anda memeriksa metode instalasi di situs web resmi yang sesuai. Jika Anda mengalami masalah, jangan ragu untuk membuat masalah.

Kemudian Anda dapat membaca perintah di bawah ini.

Perintah

Ketika Anda menemukan bahwa beberapa perintah tidak berjalan, atau tidak dapat ditemukan, lihat file package.json.

Ini mungkin karena proyek sedang diperbarui dengan cepat, tetapi pengembang yang sesuai tidak menemukan waktu untuk memperbarui dokumentasi yang sesuai.

Persiapan

Kecuali untuk perintah berikut yang perlu Anda jalankan setelah mengunduh proyek untuk pertama kalinya, Anda dapat mencoba menjalankannya lagi ketika Anda mengalami masalah.

 # 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

Jika Anda mendapatkan Rate Limit Exceeded dari GitHub, itu berarti Anda telah mencapai batas tingkat API GitHub. Proyek ini membutuhkan token akses pribadi Anda untuk tidak membatasinya.

Jika Anda belum memilikinya, buat satu, dan jalankan perintah di bawah di terminal Anda (tidak diperlukan ruang lingkup data pribadi Anda)

 export GITHUB_TOKEN= ${your token}

Pratinjau dokumen, berkembang

Saat Anda memodifikasi dokumen, blog, atau kode halaman, pratinjau dalam mode pengembangan adalah yang tercepat.

 # 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

Bangunan

Saat Anda ingin membangun atau mempratinjau situs yang terlihat sama seperti online, jalankan perintah berikut.

 # 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

Selanjutnya, Anda dapat memodifikasi dokumentasi atau kode, melakukan dan mendorongnya ke Github setelah selesai. Jika Anda tidak terbiasa dengan ini, Anda dapat membaca GitHub Flow terlebih dahulu.

Panduan Muka

Jika Anda hanya ingin memodifikasi file *.md , panduan di atas mungkin cukup.

Tetapi jika Anda perlu berkembang, silakan baca panduan di bawah ini.

Struktur proyek

Menghilangkan beberapa dokumen yang mungkin tidak penting.

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

Mengakui

Terima kasih khusus kepada Docusaurus.

Lisensi

Lisensi Apache 2.0