Skip to content

Commit

Permalink
altdoc 0.4.0 (#288)
Browse files Browse the repository at this point in the history
* bump version number

* roxygen version

* spelling

* update polars link

* cran-comments [skip ci]

* fix link and resubmit [skip ci]
  • Loading branch information
etiennebacher authored Jul 23, 2024
1 parent eec064e commit 806d2b1
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 29 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Type: Package
Package: altdoc
Title: Package Documentation Websites with 'Quarto', 'Docsify', 'Docute', or 'MkDocs'
Version: 0.3.0.9005
Version: 0.4.0
Authors@R:
c(person(given = "Etienne",
family = "Bacher",
Expand Down Expand Up @@ -45,6 +45,6 @@ Config/testthat/edition: 3
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
RoxygenNote: 7.3.2
Language: en-US
VignetteBuilder: knitr
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# News

## dev
## 0.4.0

### Breaking changes

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Quarto
🌐<a href="https://vincentarelbundock.github.io/tinytable/">vincentarelbundock.github.io/tinytable/</a>
</td>
<td>
<a href="https://github.com/vincentarelbundock/tintyable/tree/main/altdoc">Altdoc
<a href="https://github.com/vincentarelbundock/tinytable/tree/main/altdoc">Altdoc
Settings</a>
</td>
</tr>
Expand All @@ -171,7 +171,7 @@ MkDocs
<code>polars</code>
</td>
<td>
🌐<a href="https://rpolars.github.io">rpolars.github.io</a>
🌐<a href="https://pola-rs.github.io/r-polars/">pola-rs.github.io/r-polars</a>
</td>
<td>
<a href="https://github.com/pola-rs/r-polars">Github Repository</a>
Expand Down
4 changes: 2 additions & 2 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ The websites in this table were created using Altdoc:
<td>Quarto</td>
<td><code>tinytable</code></td>
<td>🌐<a href="https://vincentarelbundock.github.io/tinytable/">vincentarelbundock.github.io/tinytable/</a></td>
<td><a href="https://github.com/vincentarelbundock/tintyable/tree/main/altdoc">Altdoc Settings</a></td>
<td><a href="https://github.com/vincentarelbundock/tinytable/tree/main/altdoc">Altdoc Settings</a></td>
</tr>
<tr>
<td>Quarto</td>
Expand All @@ -111,7 +111,7 @@ The websites in this table were created using Altdoc:
<tr>
<td>MkDocs</td>
<td><code>polars</code></td>
<td>🌐<a href="https://rpolars.github.io">rpolars.github.io</a></td>
<td>🌐<a href="https://pola-rs.github.io/r-polars/">pola-rs.github.io/r-polars</a></td>
<td><a href="https://github.com/pola-rs/r-polars">Github Repository</a></td>
</tr>
<tr>
Expand Down
6 changes: 4 additions & 2 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@

0 errors | 0 warnings | 0 note

This is the second submission of altdoc 0.3.0 (first one was an hour ago). I
corrected the NOTEs reported.
## Other comments

This is the second submission of altdoc 0.4.0. First submission failed because
of a dead link in the README, that is now fixed.
41 changes: 23 additions & 18 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -1,33 +1,38 @@
Achim
Arel
Bundock
CHANGELOG
Changelog
Coene
Docsify
Docute
GPT
Github
Github's
HTTPS
LICENCE
MkDocs
Netlify
Pre
README
RStudio
Rmarkdown
Rmd
Themeable
Zeileis
customizations
docsify
Docsify
docute
Docute
firebase
frontmatter
gh
github
Github
GPT
Init
js
LICENCE
md
mkdocs
Mkdocs
MkDocs
navbar
parallelize
pkgdown
qmd
README
readthedocs
repo
Rmarkdown
Rmd
RStudio
yaml
rerender
rerendering
theming
venv
yaml
4 changes: 2 additions & 2 deletions vignettes/deploy.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ custom domain of your choice.

### Using the `main` branch and `docs/` directory

The simplest way to deploy a website from Github is to use the `docs/` directory from the `main` (or `master`) branch of your repository. Thuis process is usually very simple:
The simplest way to deploy a website from Github is to use the `docs/` directory from the `main` (or `master`) branch of your repository. This process is usually very simple:

1. Go to your Github repository settings.
2. Click on "Pages" in the left sidebar.
Expand Down Expand Up @@ -78,7 +78,7 @@ we need to change it.

6. Click on "Domain settings". In "Custom domains", click on "Add custom
domain".
7. Add a custom domaine name. For example, if you own `mywebsite.com`, you can
7. Add a custom domain name. For example, if you own `mywebsite.com`, you can
name the custom domain as `mypackage.mywebsite.com`.
8. Confirm that you are the owner of `mywebsite.com`.
9. Force HTTPS (automatically proposed by Netlify).
Expand Down

0 comments on commit 806d2b1

Please sign in to comment.