Skip to content

Commit

Permalink
docs: update link to docute website, close #49
Browse files Browse the repository at this point in the history
  • Loading branch information
etiennebacher committed Aug 28, 2023
1 parent 66e9879 commit f28f7d7
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

</div>

The goal of `altdoc` is to facilitate the use of documentation generators as alternatives to `pkgdown` websites (hence the *alt* in `altdoc`). For now, it provides helper functions to use [docute](https://docute.org/), [docsify](https://docsify.js.org/#/), and [mkdocs](https://www.mkdocs.org/).
The goal of `altdoc` is to facilitate the use of documentation generators as alternatives to `pkgdown` websites (hence the *alt* in `altdoc`). For now, it provides helper functions to use [docute](https://docute.egoist.dev//), [docsify](https://docsify.js.org/#/), and [mkdocs](https://www.mkdocs.org/).

## Demos

Expand Down Expand Up @@ -78,7 +78,7 @@ More details on the package and the deployment are available on the [website](ht

Options for each site generator can be found on their own website:

* [Docute](https://docute.org/)
* [Docute](https://docute.egoist.dev//)

* [Docsify](https://docsify.js.org/)

Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

</div>

The goal of `altdoc` is to facilitate the use of documentation generators as alternatives to `pkgdown` websites (hence the *alt* in `altdoc`). For now, it provides helper functions to use [docute](https://docute.org/), [docsify](https://docsify.js.org/#/), and [mkdocs](https://www.mkdocs.org/).
The goal of `altdoc` is to facilitate the use of documentation generators as alternatives to `pkgdown` websites (hence the *alt* in `altdoc`). For now, it provides helper functions to use [docute](https://docute.egoist.dev//), [docsify](https://docsify.js.org/#/), and [mkdocs](https://www.mkdocs.org/).

## Demos

Expand Down Expand Up @@ -78,7 +78,7 @@ More details on the package and the deployment are available on the [website](ht

Options for each site generator can be found on their own website:

* [Docute](https://docute.org/)
* [Docute](https://docute.egoist.dev//)

* [Docsify](https://docsify.js.org/)

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The second one is to create (R) Markdown files in the 'docs' folder. One drawbac

Finally, if you manually create (R) Markdown files, or if you want to modify the organization of your website, you will need to modify the sidebar. This is done in different files, depending on the documentation generator you use:

* with `docute`, everything is done in `index.html`. This is where you add sections, options, and other extensions documented [here](https://docute.org).
* with `docute`, everything is done in `index.html`. This is where you add sections, options, and other extensions documented [here](https://docute.egoist.dev/).

* with `docsify.js`, the organization of the sidebar is made in `_sidebar.md`, and options and extensions are dealt with in `index.html` (and detailed [here](https://docsify.js.org/#/)).

Expand Down

0 comments on commit f28f7d7

Please sign in to comment.