From e5e08da4a4920fb57482173561b06c4719a64f3a Mon Sep 17 00:00:00 2001 From: Pascal Burkhard Date: Sat, 28 Sep 2024 07:29:55 +0200 Subject: [PATCH] docs: fix typo and small mistakes --- README.md | 2 +- vignettes/babelquarto.qmd | 2 +- vignettes/configuration.qmd | 3 ++- vignettes/convert.qmd | 2 +- vignettes/render-with-ci.qmd | 6 +++--- 5 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index edefa0a..1f3e59a 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Each Quarto Markdown file in your project can then be translated into these furt If you start from scratch, you might want to look at `babelquarto::quarto_multilingual_book()` or `babelquarto::quarto_multilingual_website()` and read `vignette("babelquarto")`. -If you already have and existing Quarto project and want to convert it to a multilingual project, you can use `babelquarto::register_main_language()` and `babelquarto::register_further_languages()` to get started. For more information you can read `vignette("convert)`. +If you already have and existing Quarto project and want to convert it to a multilingual project, you can use `babelquarto::register_main_language()` and `babelquarto::register_further_languages()` to get started. For more information you can read `vignette("convert")`. ## Examples diff --git a/vignettes/babelquarto.qmd b/vignettes/babelquarto.qmd index da6ae68..9cb3063 100644 --- a/vignettes/babelquarto.qmd +++ b/vignettes/babelquarto.qmd @@ -156,7 +156,7 @@ This will show an URL that you can open in your IDE or browser to see your proje ## Next steps -Take a deeper dive into the configuration options available in {babelquarto} you can have a look at `vignette("configuration")`. +Take a deeper dive into the configuration options available in {babelquarto} and have a look at `vignette("configuration")`. If you want to translate your multilingual project using automatic translation with DeepL, you should have a look at [babeldown](http://docs.ropensci.org/babeldown/articles/quarto.html). diff --git a/vignettes/configuration.qmd b/vignettes/configuration.qmd index 3a7e735..c5b25b8 100644 --- a/vignettes/configuration.qmd +++ b/vignettes/configuration.qmd @@ -107,7 +107,8 @@ When rendering the main English language, {babelquarto} will load the *en* profi You could for example have different navigation menus for each language: -```{.yaml filename="_quarto-en.yml"} + +```yaml website: navbar: title: "My Website" diff --git a/vignettes/convert.qmd b/vignettes/convert.qmd index 423958e..70c8414 100644 --- a/vignettes/convert.qmd +++ b/vignettes/convert.qmd @@ -64,7 +64,7 @@ If you want to translate your multilingual project using automatic translation w ## Next steps -Take a deeper dive into the configuration options available in {babelquarto} you can have a look at `vignette("configuration")`. +Take a deeper dive into the configuration options available in {babelquarto} and have a look at `vignette("configuration")`. If you want to deploy your website on continuous integration, have a look at `vignette("render-with-ci")`. diff --git a/vignettes/render-with-ci.qmd b/vignettes/render-with-ci.qmd index cf367bc..7bab20a 100644 --- a/vignettes/render-with-ci.qmd +++ b/vignettes/render-with-ci.qmd @@ -23,11 +23,11 @@ To render your project with CI, you need to follow these general steps: * Install the necessary dependencies including Quarto and R dependencies * Render you project using {babelquarto}'s `render_book()` or `render_website()` functions -* Publish the rendered HTML (_site or _book folder) where you deploy your project (a GitHub pages branch, Netlify, etc.) +* Publish the rendered HTML (`_site` or `_book` folder) where you deploy your project (a GitHub pages branch, Netlify, etc.) -## Example +## Examples -Here are two examplee of how you could render a multilingual book with CI using GitHub Actions: +Here are two examples of how you could render a multilingual book with CI using GitHub Actions: * A demo [Babelbook](https://nenuial.github.io/babelbook/) with its [workflow file](https://github.com/Nenuial/babelbook/blob/main/.github/workflows/publish.yml) * The [rOpenSci Packages: Development, Maintenance, and Peer Review](https://devguide.ropensci.org/index.html) book with its [workflow file](https://github.com/ropensci/dev_guide/blob/main/.github/workflows/scheduled-manual-main.yml)