README (original) (raw)

altdoc is a simple and powerful package to create documentation websites for R packages. altdocmakes it trivial to create beautiful websites for simple Rpackages, and it can efficiently organize documentation for complex projects with hundreds of functions or dozens vignettes. Its features include:

You can also install the development version to benefit from the latest bug fixes:

A typical workflow with altdoc is to execute these commands from the root directory of the package:

### Create the website structure for one of the documentation generators
setup_docs(tool = "docsify")
# setup_docs(tool = "docute")
# setup_docs(tool = "mkdocs")
# setup_docs(tool = "quarto_website")

### Render the vignettes and man pages
render_docs()

### Preview the website
preview_docs()

The initial version of the logo was created with Chat-GPT and edited in Gimp by Vincent Arel-Bundock.