GitHub Pages

English | 中文 | 日本語 | 한국어 | Français | Deutsch | Español | Português | Svenska | Suomi | Nederlands

Ce depot publie le manuel avec mdBook et GitHub Pages.

Les manuels de chaque langue sont des projets mdBook independants. Chaque langue a son propre SUMMARY.md, donc la barre laterale gauche ne contient que les pages de la langue courante :

manual/
  en/
    book.toml
    SUMMARY.md
    introduction.md
    quick-start.md
    ...
  zh/
    book.toml
    SUMMARY.md
    introduction.md
    quick-start.md
    ...
  ja/
    book.toml
    SUMMARY.md
    introduction.md
    quick-start.md
    ...

Construisez localement avec :

scripts/publish-pages.sh

Le site genere est ecrit dans :

target/mdbook

Workflow de publication

Le workflow dans .github/workflows/pages.yml s’execute lors des pushes vers main et en declenchement manuel. Il :

1. Recupere le depot.
2. Installe mdBook.
3. Execute scripts/publish-pages.sh.
4. Televerse target/mdbook comme artefact Pages.
5. Deploie l’artefact vers GitHub Pages.

L’URL publiee est :

https://developerworks.github.io/rust-config-tree/

Publication de la crate

Pour le flux complet de commit, push, deploiement Pages et publication de la crate :

scripts/release.sh --execute --message "Release 0.1.3"

Utilisez l’assistant de publication de crate depuis la racine du depot :

scripts/publish-crate.sh

Le mode par defaut lance les controles et cargo publish --dry-run. Pour publier sur crates.io apres la reussite des controles. Si la version courante existe deja sur crates.io, le script incremente automatiquement la version patch :

scripts/publish-crate.sh --execute

L’utilisation des scripts est resumee dans scripts/README.md.