GitHub Pages

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

Este repositorio publica o manual com mdBook e GitHub Pages.

Os manuais de cada idioma sao projetos mdBook independentes. Cada idioma tem seu proprio SUMMARY.md, entao a barra lateral esquerda contem apenas paginas do idioma atual:

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

Construa localmente com:

scripts/publish-pages.sh

O site gerado e gravado em:

target/mdbook

Workflow de publicacao

O workflow em .github/workflows/pages.yml roda em pushes para main e por acionamento manual. Ele:

1. Faz checkout do repositorio.
2. Instala mdBook.
3. Executa scripts/publish-pages.sh.
4. Envia target/mdbook como artefato Pages.
5. Implanta o artefato no GitHub Pages.

A URL publicada e:

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

Lancamento do crate

Para o fluxo completo de commit, push, deploy do Pages e publicacao do crate:

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

Use o auxiliar de lancamento do crate a partir da raiz do repositorio:

scripts/publish-crate.sh

O modo padrao executa verificacoes e cargo publish --dry-run. Para publicar no crates.io depois que as verificacoes passarem. Se a versao atual ja existir no crates.io, o script incrementa a versao patch automaticamente:

scripts/publish-crate.sh --execute

O uso dos scripts e resumido em scripts/README.md.