← Cloudflare Pages / pages / framework-guides

MkDocs

MkDocs ↗ je moderní dokumentační platforma, na které týmy mohou dokumentovat produkty, interní znalostní báze a API.

MkDocs vyžaduje, abyste měli v systému nainstalovanou aktuální verzi Pythonu a jeho správce balíčků pip. Návod k instalaci pip najdete v Průvodce instalací MkDocs ↗. Po nainstalování pip spusťte:

pip install mkdocs

Použijte mkdocs new příkaz k vytvoření nové aplikace:

mkdocs new <PROJECT_NAME>

Poté cd do svého projektu vezměte MkDocs a jeho závislosti a vložte je do requirements.txt soubor:

pip freeze > requirements.txt

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 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

Úspěšně jste vytvořili repozitář GitHub a nahráli do něj svůj projekt MkDocs.

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í a nasazení sekci uveďte následující informace:

7. Přejděte na Environment variables (advanced) > Přidat proměnnou > a přidejte proměnnou PYTHON_VERSION s hodnotou 3.7.

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

Pokaždé, když do svého webu MkDocs odešlete commit s novým kódem, 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.

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