{"id":14069146,"url":"https://github.com/Appsilon/readmebuilder","last_synced_at":"2025-07-30T05:31:31.487Z","repository":{"id":48415207,"uuid":"177170546","full_name":"Appsilon/readmebuilder","owner":"Appsilon","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-02T20:51:07.000Z","size":8,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-13T07:15:40.739Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/Appsilon.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-22T16:02:03.000Z","updated_at":"2019-07-03T23:29:31.000Z","dependencies_parsed_at":"2024-08-13T07:25:27.291Z","dependency_job_id":null,"html_url":"https://github.com/Appsilon/readmebuilder","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Appsilon%2Freadmebuilder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Appsilon%2Freadmebuilder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Appsilon%2Freadmebuilder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Appsilon%2Freadmebuilder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Appsilon","download_url":"https://codeload.github.com/Appsilon/readmebuilder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228092158,"owners_count":17868141,"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":[],"created_at":"2024-08-13T07:06:39.125Z","updated_at":"2024-12-04T10:30:59.805Z","avatar_url":"https://github.com/Appsilon.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"ReadmebuildeR\n=============\n\nA simple R package to automatically build consistently formated and nicely looking READMEs and simple package websites.\n\n## Installation\n\n```\ndevtools::install_github(\"Appsilon/readmebuilder\")\n```\n\n## How to use it?\n\nRun:\n\n```r\nbuild_readme(\"examples/README.Rmd\", output_md = 'README2.md')\n```\n\nand check `examples/README.Rmd` for formatting of Rmd file.\n\nNote **two** things here:\n\n1. This is responsible for selecting folder which will contain all your static images generated by Rmd active R cells.\n\n```r\nknitr::opts_chunk$set(\n  ...\n  fig.path = \"examples/README_files/\"\n)\n```\n\nTo access screenshots of generated active cells include `screenshot.force = TRUE` parameter in cell definition:\n\n```\n{r, screenshot.force = TRUE}\n```\n\n2. You can manipulate the style of generated `html` file just by adding this line to Rmd file:\n\n```\n\u003clink href='style.css' rel='stylesheet' type='text/css'\u003e\n```\n\nand including `style.css` file in the folder containing your html output.\n\n\nFor more details check the documentation of the `build_readme` function.\n\n## Credits\n\n[Appsilon Data Science Team](http://appsilon.com).\n\nGet in touch [dev@appsilon.com](dev@appsilon.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAppsilon%2Freadmebuilder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAppsilon%2Freadmebuilder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAppsilon%2Freadmebuilder/lists"}