{"id":21082852,"url":"https://github.com/jxareas/rapidbook","last_synced_at":"2025-05-16T09:32:18.937Z","repository":{"id":58842800,"uuid":"533237174","full_name":"jxareas/RapidBook","owner":"jxareas","description":"A template to quickly deploy Python/R based books using the Bookdown CRAN package.","archived":false,"fork":false,"pushed_at":"2022-09-22T05:48:15.000Z","size":1295,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-03-08T23:40:08.972Z","etag":null,"topics":["book-template","bookdown","learn","machine-learning","markdown","python-book","r","r-bookdown","r-language","r-programming","rbook","rmarkdown","rmarkdown-document","rmarkdown-template","rmarkdown-websites","rstudio","statistics","template","templates"],"latest_commit_sha":null,"homepage":"https://jxareas.github.io/RapidBook/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jxareas.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}},"created_at":"2022-09-06T08:47:03.000Z","updated_at":"2023-03-08T23:40:08.972Z","dependencies_parsed_at":"2023-01-19T01:46:03.839Z","dependency_job_id":null,"html_url":"https://github.com/jxareas/RapidBook","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jxareas%2FRapidBook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jxareas%2FRapidBook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jxareas%2FRapidBook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jxareas%2FRapidBook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jxareas","download_url":"https://codeload.github.com/jxareas/RapidBook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225419555,"owners_count":17471434,"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":["book-template","bookdown","learn","machine-learning","markdown","python-book","r","r-bookdown","r-language","r-programming","rbook","rmarkdown","rmarkdown-document","rmarkdown-template","rmarkdown-websites","rstudio","statistics","template","templates"],"created_at":"2024-11-19T20:15:28.341Z","updated_at":"2024-11-19T20:15:28.986Z","avatar_url":"https://github.com/jxareas.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\r\n\u003cstrong\u003e\u003cem\u003eRapidBook\u003c/em\u003e\u003c/strong\u003e\r\n\u003c/h1\u003e\r\n\r\nThis is a template, created with the purpose of quickly creating, customizing and deploying a Book-like website using the [`Bookdown` R package](https://github.com/rstudio/bookdown), to be hosted on Github Pages. \r\n\r\n[You can view the currently deployed template here.](https://jxareas.github.io/RapidBook/)\r\n\r\n\r\n## Instructions 📋\r\n\r\nFollow these instructions to either use, deploy or customize the template:\r\n\r\n### Copy this template\r\n\r\n- [ ] 1. Click the green \"Use this template\" button above.  **DO NOT FORK THE REPO** if you intend to use this as a template.  Choose a descriptive name for your repo depending on what you intend to do.\r\n\r\n### Deploy with GitHub Pages 🚀\r\n\r\n- [ ] 1. On the home page of your repo, click Settings. Scroll down to the GitHub pages section and change **Source** to **master branch /docs folder**.  Above the **Source** line, a bar will appear with your book's URL. The bar will initially be blue and indicate that your book is *ready* to be published and will change to green once it is published. Copy the URL. (Note that sometimes there is a delay until your book actually appears at that URL. If it doesn't appear after a few minutes, make a change and commit it to trigger a GitHub Pages build.)\r\n\r\n- [ ] 2. Click the gear button near \"About\" on the home page of the repo and paste your book URL into the **Website** field that appears on the right.\r\n\r\n### Clone your repo\r\n\r\n- [ ] 1. Clone your new repo with *File, New Project..., Version Control, Git* in RStudio.\r\n\r\n### **Edit some key files**\r\n\r\n- [ ] 1. In `index.Rmd`, enter the TITLE of your book in the `title:` key. \r\n\r\n- [ ] 2. In `index.Rmd`, enter your NAME in the `author:` key.\r\n\r\n- [ ] 3. In `index.Rmd` enter your github repository in the `github-repo` key.\r\n\r\n- [ ] 3. In `index.Rmd` enter the current url of the website as the `url` key, once deployed to Github Pages.\r\n\r\n- [ ] 5. In `index.Rmd` enter the description of your project.\r\n\r\n\r\n- [ ] 6. In `_bookdown.yml`, change YOUR GITHUB USERNAME to your GitHub username in the two places it appears.\r\n\r\n- [ ] 7. In `_bookdown.yml`, change YOUR GITHUB REPO to your GitHub repo name in the two places it appears.\r\n\r\n- [] 8. In `_output.yml`, specify the name of your default branch, which is usually either `main` or `master`. In this template it defaults to master.\r\n\r\n(Note that 6. and 7. provide links to the `.Rmd` files of your project for editing and viewing. If you move your `.Rmd` files you will need to update these file paths. Once your book is rendered, test that the edit (pen) and view (eye) buttons work.)\r\n\r\n- [ ] 5. In `_output.yml`, change YOUR SHORT TITLE to a shortened version of your title. (Leave the \"after:\" line indicating that the book was published with bookdown as is.)\r\n\r\n### Customize this template 🎇\r\n\r\nYou can easily customize the theme and fonts of the book, in the `_output.yml` file:\r\n\r\n- Primary Color: set your color in hexadecimal format, in the `primary` key, which is by default set to Purple (#4E11A8).\r\n- Base Font: set the base font of the website, in the `base_font` key, which is by default set to Lato.\r\n- Heading Font: set the heading font of the website, in the `heading_font` key, which is by default set to Poppins.\r\n- Code Font: set the code font of the website, in the `code_font` key, which is by default set to DM Mono.\r\n\r\n\r\n\r\n### Render the book\r\n\r\n- [ ] 1. Install **bookdown** with `install.packages(\"bookdown\")`. If you already have it, update to the [latest version](https://CRAN.R-project.org/package=bookdown).\r\n\r\n- [ ] 2. Render locally with `bookdown::render_book(\"index.Rmd\")`.\r\n\r\n- [ ] 3. Use `browseURL(\"docs/index.html\")` to view your book locally (or just open `index.html` in a browser).\r\n\r\n- [ ] 4. If it looks good, commit and push all changed files to GitHub. \r\n\r\n(You will need to repeat steps 2 and 4 every time you wish to update the book online.)\r\n\r\n### Additional features\r\n\r\nConsult the official guide to **bookdown**: https://bookdown.org/yihui/bookdown\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjxareas%2Frapidbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjxareas%2Frapidbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjxareas%2Frapidbook/lists"}