{"id":13942746,"url":"https://github.com/liangyy/template_r_documentation","last_synced_at":"2025-07-20T06:31:54.396Z","repository":{"id":19690218,"uuid":"87661653","full_name":"liangyy/template_r_documentation","owner":"liangyy","description":"This is a light template for documentation based on rmarkdown","archived":false,"fork":false,"pushed_at":"2023-04-16T23:46:40.000Z","size":1250,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-27T12:36:54.199Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://liangyy.github.io/template_r_documentation","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/liangyy.png","metadata":{"files":{"readme":"README.md","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,"roadmap":null,"authors":null,"dei":null}},"created_at":"2017-04-08T20:18:44.000Z","updated_at":"2022-02-18T02:09:42.000Z","dependencies_parsed_at":"2024-04-10T16:06:10.833Z","dependency_job_id":null,"html_url":"https://github.com/liangyy/template_r_documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/liangyy/template_r_documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liangyy%2Ftemplate_r_documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liangyy%2Ftemplate_r_documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liangyy%2Ftemplate_r_documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liangyy%2Ftemplate_r_documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/liangyy","download_url":"https://codeload.github.com/liangyy/template_r_documentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liangyy%2Ftemplate_r_documentation/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266076350,"owners_count":23872741,"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-08T02:02:00.959Z","updated_at":"2025-07-20T06:31:51.753Z","avatar_url":"https://github.com/liangyy.png","language":null,"funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"# template_r_documentation\n\nThis is a light template for documentation based on rmarkdown.\n\n## Overview\n\nThis is based on rmarkdown. As a quick look at how things work, the way the documentations glued together is:\n\n1. `_site.yml` tells what should be at navigation bar and it also determines the overall style.\n2. `index.html` and other files that are linked by `_site.yml` can further link to other files (namely sub contents).\n3. run `render_site([file-name])` to generate `html` file from `Rmd` file.\n4. add, commit, and push everything at the end of the day.\n\n## Notes\n\n1. `docs/` contains all `html` files and be sure to enable Github Pages (`docs/` mode).\n2. put all `Rmd` files at `rmd/` and in R terminal, run `render_site('rmd/filename.Rmd')` and it will generate the corresponding `html` at `docs/`\n\n## Build yourself\n\nAll you need to get started is the files in `rmd/`. Once you get them, do the following in R terminal:\n\n```\nsetwd('some_path/template_r_documentation')\nlibrary(rmarkdown)\nrender_site(input = 'rmd/')\n```\n\nTo render a new file, say `new.Rmd`, do:\n\n```\nrender_site(input = 'rmd/new.Rmd`)\n```\n\n## See also\n\nThis is a super light and lazy (quick) solution. It is inspired by [this post](http://nickstrayer.me/RMarkdown_Sites_tutorial/) and [workflowr](https://github.com/jdblischak/workflowr). To get a more advanced and prettier solution, please check out [workflowr](https://github.com/jdblischak/workflowr).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliangyy%2Ftemplate_r_documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliangyy%2Ftemplate_r_documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliangyy%2Ftemplate_r_documentation/lists"}