{"id":27393192,"url":"https://github.com/ronnyhdez/docmaker","last_synced_at":"2025-04-13T22:13:22.338Z","repository":{"id":44928847,"uuid":"431676092","full_name":"ronnyhdez/docmaker","owner":"ronnyhdez","description":"A package to take your Rmarkdown notes to mkdocs and github pages","archived":false,"fork":false,"pushed_at":"2023-04-12T02:02:43.000Z","size":14369,"stargazers_count":2,"open_issues_count":14,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T22:13:17.769Z","etag":null,"topics":["documentation","mkdocs","rmarkdown","rpackage"],"latest_commit_sha":null,"homepage":"https://ronnyhdez.github.io/docmaker/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ronnyhdez.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-11-25T01:21:38.000Z","updated_at":"2024-10-20T02:51:42.000Z","dependencies_parsed_at":"2022-08-27T23:12:11.391Z","dependency_job_id":"ecd022ec-244d-4f44-aa6d-e6b6fcf40150","html_url":"https://github.com/ronnyhdez/docmaker","commit_stats":{"total_commits":34,"total_committers":1,"mean_commits":34.0,"dds":0.0,"last_synced_commit":"834ab61827dfa7547c904a538c05dc81260148f9"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronnyhdez%2Fdocmaker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronnyhdez%2Fdocmaker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronnyhdez%2Fdocmaker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronnyhdez%2Fdocmaker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ronnyhdez","download_url":"https://codeload.github.com/ronnyhdez/docmaker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788913,"owners_count":21161728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","mkdocs","rmarkdown","rpackage"],"created_at":"2025-04-13T22:13:21.753Z","updated_at":"2025-04-13T22:13:22.310Z","avatar_url":"https://github.com/ronnyhdez.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# docmaker \u003ca href=\"url\"\u003e\u003cimg src=\"man/figures/logo.png\" align=\"right\" width=\"30%\"\u003e\u003c/a\u003e\n\n\u003c!-- badges: start --\u003e\n[![CRAN status](https://www.r-pkg.org/badges/version/docmaker)](https://cran.r-project.org/package=docmaker)\n[![R-CMD-check](https://github.com/ronnyhdez/docmaker/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ronnyhdez/docmaker/actions/workflows/R-CMD-check.yaml)\n\u003c!-- badges: end --\u003e\n\n## Overview\n\n`docmaker` is a package that allows you to automate your workflow for taking\nnotes or creating documentation and publish it as a webpage using GitHub pages,\nMkDocs, and Rmarkdown or Quarto or Markdown.\n\nIf you have a repository with files built with Rmarkdown/Quarto/Markdown that you \nwould like to take to MkDocs; `docmaker` will help you with the all the steps\nin the middle to achieve this.\n\n## Installation\n\nYou can install the development version of `docmaker` from [GitHub](https://github.com/) with:\n\n```{r, eval = FALSE}\ndevtools::install_github(\"ronnyhdez/docmaker\")\n```\n\nIf you don´t have the `devtools` package installed, run the following:\n\n```{r, eval = FALSE}\ninstall.packages(\"devtools\")\n```\n\n## Usage\n\nYou can create your repository on GitHub, clone your repo and from there, you\nwill need to implement a structure to be able to use GitHub pages and MkDocs. \nFor this you can use the function:\n\n```{r build_repo example, eval = FALSE}\nlibrary(docmaker)\nbuild_repo(github_page_url = \"https://ronnyhdez.github.io/drawer/\",\n           site_author = \"Ronny A. Hernández Mora\")\n```\n\nOnce you have a repository, you can take your Rmarkdown/Quarto/Markdown notes\nand deploy them with GitHub pages\n\n```{r make_doc example, eval = FALSE}\nmake_doc(file = \"check.Rmd\", mkdocs_build = TRUE, mkdocs_deploy = TRUE)\n```\n\nIf you have several files in the root of your project directory, you can instead\nuse the following function to build and deploy all your Rmd files:\n\n```{r make_all_docs example, eval  = FALSE}\nmake_all_docs(deploy = TRUE)\n```\n\nIn the case of having `md` files, you can use the following function to update\nthem in the folder that is deployed to GitHub pages:\n\n```{r, eval = FALSE}\nupdate_md_files(\"~/Desktop/test_docmaker\")\n```\n\nIf a file is no longer needed, and you erase that file from your root directory,\nit will needed to update the `docs/` folder. In that case we can use the \nfunction:\n\n```{r, eval = FALSE}\nclean_files()\n```\n\n## Getting help\n\nIf you find a bug please fill an issue with a reproducible example on [GitHub](https://github.com/ronnyhdez/docmaker/issues/)\n\n## Ref\n\nImage is the bibliotekarien\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fronnyhdez%2Fdocmaker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fronnyhdez%2Fdocmaker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fronnyhdez%2Fdocmaker/lists"}