INTEGRITY Dokumentace

Docusaurus

Docusaurus je generátor statických webů. Vytváří jednostránkovou aplikaci s rychlou navigací na straně klienta a využívá plnou sílu Reactu k tomu, aby byl váš web interaktivní. Nabízí ihned použitelné funkce pro dokumentaci, ale dá se použít k vytvoření libovolného typu webu, ať už osobního webu, produktového webu, blogu nebo marketingových vstupních stránek.

Nastavení nového projektu

Použijte create-cloudflare CLI (C3) k nastavení vašeho projektu. C3 vytvoří nový adresář projektu, spustí oficiální nástroj pro nastavení Docusaurus a nabídne možnost okamžitého nasazení.

Chcete-li použít create-cloudflare k vytvoření nového projektu Docusaurus spusťte následující příkaz:

npm create cloudflare@latest -- my-docusaurus-app --framework=docusaurus --platform=pages

create-cloudflare nainstaluje další závislosti, mimo jiné Wrangler CLI a všechny potřebné adaptéry a položí vám otázky k nastavení.

Než budete pokračovat

Všechny průvodce frameworky předpokládají, že již máte základní znalosti Git. Pokud s Gitem začínáte, podívejte se na tento shrnutá příručka ke Gitu jak nastavit Git na svém lokálním počítači.

Pokud klonujete přes SSH, musíte vygenerujte SSH klíče na každém počítači, který používáte pro push nebo pull z GitHubu.

Viz dokumentace GitHub a Dokumentace Git s dalšími informacemi.

Vytvořte repozitář GitHub

Vytvořte nový repozitář GitHub na repo.new. Po vytvoření nového repozitáře přejděte do adresáře nově vytvořeného projektu a v terminálu spusťte následující příkazy, kterými připravíte a odešlete svou místní aplikaci na GitHub:

git init
git remote add origin https://github.com/<your-gh-username>/<repository-name>
git add .
git commit -m "Initial commit"
git branch -M main
git push -u origin main

Nasadit pomocí Cloudflare Pages

Nasadit přes create-cloudflare CLI (C3)

Pokud používáte create-cloudflare(C3) k vytvoření nového projektu Docusaurus nainstaluje C3 všechny závislosti, které projekt potřebuje, a vyzve vás k nasazení projektu přes CLI. Pokud jej nasadíte, web se zveřejní a získáte URL adresu nasazení.

Nasadit přes Cloudflare dashboard

Chcete-li nasadit svůj web do Pages:

  1. V dashboardu Cloudflare přejděte na Workers & Pages stránce.

    Přejděte na Workers & Pages ↗
  2. Vyberte Vytvoření aplikace.

  3. Vyberte Pages kartě.

  4. Vyberte Importujte existující repozitář Git.

  5. Vyberte nově vytvořený repozitář GitHub a poté vyberte Zahájit nastavení.

  6. V Nastavení sestavení sekci vyberte Docusaurus jako Přednastavení frameworku. Váš výběr poskytne následující informace:

Konfigurační možnostHodnota
Produkční větevmain
Příkaz sestavenínpm run build
Adresář sestaveníbuild

Po nasazení webu získáte pro svůj projekt jedinečnou subdoménu na *.pages.dev.

Pokaždé, když do svého webu Docusaurus odešlete commit s novým kódem a tyto změny nahrajete na GitHub, Cloudflare Pages automaticky znovu sestaví a nasadí váš projekt. Získáte také přístup k náhledová nasazení u nových pull requestů a budete moci si prohlédnout, jak změny na vašem webu vypadají, než je nasadíte do produkce.

Kompletní návod k nasazení vašeho prvního webu na Cloudflare Pages najdete v Úvodní návod.

Zjistit více

Dokončením tohoto návodu jste úspěšně nasadili svůj web Docusaurus na Cloudflare Pages. Chcete-li začít s dalšími frameworky, podívejte se na seznam návodů pro frameworky.