Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #78

Merged
merged 29 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
bd4e074
docs: rewrite README
Nenuial Sep 18, 2024
265fabc
docs: prepare for Quarto vignettes
Nenuial Sep 18, 2024
1f6e6cb
docs: vignette Getting started
Nenuial Sep 18, 2024
df523b7
docs: vignette Convert and existing project
Nenuial Sep 18, 2024
a6f2ca1
docs: vignette Configuration
Nenuial Sep 18, 2024
d5c1333
docs: vignette Render with CI
Nenuial Sep 18, 2024
62bde70
chore: linting
Nenuial Sep 18, 2024
e35df48
docs: fix configuration vignette index entry
Nenuial Sep 18, 2024
bb55ac8
chore: fix windows CI
Nenuial Sep 19, 2024
b973338
docs: apply review suggestions to babelquarto vignette
Nenuial Sep 19, 2024
97ea75c
docs: apply review suggestions to configuration vignette
Nenuial Sep 19, 2024
fbe8264
docs: add link to babeldown in the next steps sections
Nenuial Sep 19, 2024
6f42ffb
docs: apply review suggestions to render-with-ci vignette
Nenuial Sep 19, 2024
63ae254
docs: mention quarto preview in the previewing part
Nenuial Sep 19, 2024
1a1f565
docs: make sure people understand that babelquarto doesn't translate
Nenuial Sep 19, 2024
d2c2b0c
docs: add `main_language` and `further_languages` to book and website…
Nenuial Sep 19, 2024
df8bd88
docs: add more information to main README
Nenuial Sep 19, 2024
769f559
chore: fix CI
Nenuial Sep 19, 2024
1e2d750
docs: add examples to README
Nenuial Sep 20, 2024
3399eb8
docs: better title for custom language links
Nenuial Sep 20, 2024
72da76b
docs: document custom templates with babelquarto
Nenuial Sep 25, 2024
c88e2f6
chore: lintr rules no longer need an exception for the Getting starte…
Nenuial Sep 26, 2024
d019159
docs: apply review suggestions to README
Nenuial Sep 26, 2024
e872830
docs: apply review suggestions to the Getting started vignette
Nenuial Sep 26, 2024
cecfe47
docs: apply review suggestions to the Configuration vignette
Nenuial Sep 26, 2024
35c71da
docs: apply review suggestions to the Convert vignette
Nenuial Sep 26, 2024
7ee68b3
docs: apply review suggestions to Custom templates vignette
Nenuial Sep 26, 2024
8e8daa9
docs: rewrite the Render with CI vignette completely
Nenuial Sep 26, 2024
ad47623
docs: add a second example for CI render
Nenuial Sep 27, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,14 @@ jobs:

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::rcmdcheck
extra-packages: |
any::rcmdcheck
any::devtools
needs: check

- run: devtools::install(build_vignettes = FALSE)
shell: Rscript {0}

- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
.Rdata
.httr-oauth
.DS_Store

docs
vignettes/*_files
2 changes: 1 addition & 1 deletion .lintr
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ encoding: "UTF-8"
exclusions: list(
# excluded from all lints:
"tests/testthat.R"
)
)
2 changes: 2 additions & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,5 @@ Suggests:
URL: https://github.com/ropensci-review-tools/babelquarto
BugReports: https://github.com/ropensci-review-tools/babelquarto/issues
Config/testthat/edition: 3
VignetteBuilder:
quarto
226 changes: 0 additions & 226 deletions README.Rmd

This file was deleted.

Loading
Loading