Skip to content

Commit 19fe88b

Browse files
committed
docs: fix typo and small mistakes
1 parent 40de30f commit 19fe88b

File tree

5 files changed

+8
-7
lines changed

5 files changed

+8
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Each Quarto Markdown file in your project can then be translated into these furt
3737

3838
If you start from scratch, you might want to look at `babelquarto::quarto_multilingual_book()` or `babelquarto::quarto_multilingual_website()` and read `vignette("babelquarto")`.
3939

40-
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)`.
40+
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")`.
4141

4242
## Examples
4343

vignettes/babelquarto.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ This will show an URL that you can open in your IDE or browser to see your proje
156156

157157
## Next steps
158158

159-
Take a deeper dive into the configuration options available in {babelquarto} you can have a look at `vignette("configuration")`.
159+
Take a deeper dive into the configuration options available in {babelquarto} and have a look at `vignette("configuration")`.
160160

161161
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).
162162

vignettes/configuration.qmd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,8 @@ When rendering the main English language, {babelquarto} will load the *en* profi
107107

108108
You could for example have different navigation menus for each language:
109109

110-
```{.yaml filename="_quarto-en.yml"}
110+
<!-- ```{.yaml filename="_quarto-en.yml"} -->
111+
```yaml
111112
website:
112113
navbar:
113114
title: "My Website"

vignettes/convert.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ If you want to translate your multilingual project using automatic translation w
6464

6565
## Next steps
6666

67-
Take a deeper dive into the configuration options available in {babelquarto} you can have a look at `vignette("configuration")`.
67+
Take a deeper dive into the configuration options available in {babelquarto} and have a look at `vignette("configuration")`.
6868

6969
If you want to deploy your website on continuous integration, have a look at `vignette("render-with-ci")`.
7070

vignettes/render-with-ci.qmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ To render your project with CI, you need to follow these general steps:
2323

2424
* Install the necessary dependencies including Quarto and R dependencies
2525
* Render you project using {babelquarto}'s `render_book()` or `render_website()` functions
26-
* Publish the rendered HTML (_site or _book folder) where you deploy your project (a GitHub pages branch, Netlify, etc.)
26+
* Publish the rendered HTML (`_site` or `_book` folder) where you deploy your project (a GitHub pages branch, Netlify, etc.)
2727

28-
## Example
28+
## Examples
2929

30-
Here are two examplee of how you could render a multilingual book with CI using GitHub Actions:
30+
Here are two examples of how you could render a multilingual book with CI using GitHub Actions:
3131

3232
* A demo [Babelbook](https://nenuial.github.io/babelbook/) with its [workflow file](https://github.com/Nenuial/babelbook/blob/main/.github/workflows/publish.yml)
3333
* 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 commit comments

Comments
 (0)