{"id":15165902,"url":"https://github.com/mdequeljoe/rdoc","last_synced_at":"2025-10-25T09:31:02.149Z","repository":{"id":56936885,"uuid":"173148470","full_name":"mdequeljoe/rdoc","owner":"mdequeljoe","description":"colourised R docs in the terminal","archived":false,"fork":false,"pushed_at":"2019-05-30T10:06:00.000Z","size":576,"stargazers_count":49,"open_issues_count":4,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-31T06:51:18.042Z","etag":null,"topics":["cli","colorization","crayon","documentation","pretty-print","r","rstats"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mdequeljoe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-28T16:37:40.000Z","updated_at":"2024-02-06T13:45:33.000Z","dependencies_parsed_at":"2022-08-21T05:50:45.647Z","dependency_job_id":null,"html_url":"https://github.com/mdequeljoe/rdoc","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdequeljoe%2Frdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdequeljoe%2Frdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdequeljoe%2Frdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdequeljoe%2Frdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mdequeljoe","download_url":"https://codeload.github.com/mdequeljoe/rdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238112937,"owners_count":19418535,"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":["cli","colorization","crayon","documentation","pretty-print","r","rstats"],"created_at":"2024-09-27T04:05:59.059Z","updated_at":"2025-10-25T09:30:56.788Z","avatar_url":"https://github.com/mdequeljoe.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rdoc\n[![Build Status](https://travis-ci.org/mdequeljoe/rdoc.svg?branch=master)](https://travis-ci.org/mdequeljoe/rdoc)\n[![CRAN Status](https://www.r-pkg.org/badges/version/rdoc)](https://cran.r-project.org/package=rdoc)\n[![codecov](https://codecov.io/gh/mdequeljoe/rdoc/branch/master/graph/badge.svg)](https://codecov.io/gh/mdequeljoe/rdoc)\n[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)\n\nrdoc = `help` + `tools::Rd2txt` + [cli](https://github.com/r-lib/cli) + [crayon](https://github.com/r-lib/crayon) + [prettycode](https://github.com/r-lib/prettycode)\n\n![](man/img/rdoc.png)\n\n\n`rdoc` can also be used in console sessions whereby the output will be interactively printed by section to avoid flooding it with too much text. The `\u003center\u003e` keypress will\nprint the next section and any other keypress will exit the interaction without printing\nthe remaining sections. This can be disabled via `options` (see below).\n\n![](man/img/console.png)\n\n## install\n\n```r\ndevtools::install_github(\"mdequeljoe/rdoc\")\n```\n## options\n\nCustomising `rdoc` output is possible via `options`:\n\n```r\n# text formats - defaults to rdoc_text_formats()\noptions(rdoc.text_formats = rdoc::rdoc_text_formats(pkg = crayon::cyan))\n\n# doc style - defaults to rdoc_style()\noptions(rdoc.style = rdoc::rdoc_style(arguments = function(x) paste0(\"@\", x)))\n\n# item bullet style to pass to tools::Rd2txt\noptions(rdoc.item_bullet = \"\u003e\u003e \")\n\n#whether to include a package header, defaults to TRUE\noptions(rdoc.header = FALSE)\n\n#whether output be split by sections for non-terminal usage, defaults to TRUE\noptions(rdoc.by_section = FALSE)\n\n```\n\n## base replacements\n\n`help` and `?` can be overridden via:\n\n```r\nrdoc::use_rdoc()\n```\n\nResetting is possible with:\n\n```r\nrdoc::rm_rdoc()\n```\n\n## contributing\n\ncontributions/suggestions welcome!\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdequeljoe%2Frdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdequeljoe%2Frdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdequeljoe%2Frdoc/lists"}