Skip to content

Commit

Permalink
docs: fix typo and small mistakes
Browse files Browse the repository at this point in the history
  • Loading branch information
Nenuial committed Sep 28, 2024
1 parent 40de30f commit 19fe88b
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion vignettes/babelquarto.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
3 changes: 2 additions & 1 deletion vignettes/configuration.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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 filename="_quarto-en.yml"} -->
```yaml
website:
navbar:
title: "My Website"
Expand Down
2 changes: 1 addition & 1 deletion vignettes/convert.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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")`.

Expand Down
6 changes: 3 additions & 3 deletions vignettes/render-with-ci.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 19fe88b

Please sign in to comment.