ดาวน์โหลด apisix website - ดาวน์โหลดแหล่งข้อมูล apisix website

apisix website

ข้อมูลเว็บไซต์

1.0.0

ดาวน์โหลด

เว็บไซต์ Apache Apisix®

เว็บไซต์ของ Apache Apisix®

เกตเวย์ Microservices Microservices Cloud-Native

เริ่มต้น

หากคุณต้องการเขียนบล็อกหรือแก้ไขปัญหาที่เกี่ยวข้องกับบล็อกโปรดอ่านคู่มือการสนับสนุนบล็อก Apache Apisix ก่อน

สิ่งที่ต้องมีก่อน

ก่อนอื่นคุณต้องติดตั้ง Git

จากนั้นคุณควรแยก repo นี้และโคลนส้อมของคุณ:

 # 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 , เส้นด้าย

เคล็ดลับ: เนื่องจากวิธีการติดตั้งอาจเปลี่ยนแปลงเราขอแนะนำให้คุณตรวจสอบวิธีการติดตั้งบนเว็บไซต์ทางการที่เกี่ยวข้อง หากคุณพบปัญหาใด ๆ โปรดสร้างปัญหา

จากนั้นคุณสามารถอ่านคำสั่งด้านล่าง

คำสั่ง

เมื่อคุณพบว่าคำสั่งบางอย่างไม่รันหรือไม่พบให้ดูที่ไฟล์ 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 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