Build repo template — build

A function to create the minimum files and folders require to build a repository to work with mkdocs and GitHub pages.

Usage

build_repo(github_page_url, site_author)

Arguments

github_page_url: Your GitHub page name. You can check this when you configure the GitHub pages in your repository. This is going to be written in the mkdocs.yml file.
site_author: The name of the author. This is going to be written in the mkdocs.yml file.

Details

This will create an empty docs folder where all your md files will be located coupled with output files as images. Also it will create a mkdocs.yml file that uses material theme, contains the site url and the author name.

Author

Ronny Alexander Hernández Mora

Examples

if (FALSE) {
build_repo(github_page_url = "https://ronnyhdez.github.io/drawer/",
           site_author = "Ronny A. Hernández Mora")
}