In ColinFay/backyard: A Web App for Easier Bookdown Collaboration
Overview
How is a {backyard} backend organized?
Launch
backyard::run_book() (without any parameter filled) opens an invite box that can either be used for:
-
creating a new bookdown (point to the folder where you want your bookdown to be saved, and add a folder name). If you choose this option, the default Bookdown template is used
-
pointing to an Index.Rmd of a bookdown already present on the machine
You can pass to backyard::run_book() the location of the index.Rmd (then the app is launched for this bookdown), or the location of your home (for the folder selection invite, default is .).
By default, the safe_mode parameter is set to TRUE. This mode creates, at launch time, a copy (in {path}/backyard_copy-{time}) of your current version of the bookdown folder. That way, if ever you do something wrong during your backyard session, you can still go back to the previous version.
About
This first page gives you a quick overview of the book.
Chapters
This tab has 2 other tabs:
-
Chapter edit: edit a chapter in html with the WYSIWYG (What you see is what you get) editor. Don't forget to save when you're done. If you're more comfortable with markdown, you can also use the “update as Markdown” interface of this window.
-
Manage Chapter: Add, delete, rename, reorder chapters
About code blocks in interactive mode
Code blocks are, on purpose, not editable in Interactive mode. You should switch to Markdown mode if you want to edit these elements.
Options
The idea of this tab is that non-tech people don't want to enter too many technical details, hence they have “textual” content to see. If you want to dig into the tech, two tabs can be used to do that.
-
Global: edit some global options with a friendly UI
-
Edit options manually: change the options of Index.Rmd, _output.yml and _bookdown.yml just as if you were in any editor
-
Edit any file: open an editor for any file contained in same directory as the index.Rmd. ## Design
Two things can be edited in this tab:
-
CSS: edit, create and delete CSS files
-
Highlight: change the book syntax highlighting
ColinFay/backyard documentation built on June 29, 2019, 3:54 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Overview
How is a {backyard} backend organized?
Launch
backyard::run_book() (without any parameter filled) opens an invite box that can either be used for:
-
creating a new bookdown (point to the folder where you want your bookdown to be saved, and add a folder name). If you choose this option, the default Bookdown template is used
-
pointing to an Index.Rmd of a bookdown already present on the machine
You can pass to backyard::run_book() the location of the index.Rmd (then the app is launched for this bookdown), or the location of your home (for the folder selection invite, default is .).
By default, the safe_mode parameter is set to TRUE. This mode creates, at launch time, a copy (in {path}/backyard_copy-{time}) of your current version of the bookdown folder. That way, if ever you do something wrong during your backyard session, you can still go back to the previous version.
About
This first page gives you a quick overview of the book.
Chapters
This tab has 2 other tabs:
-
Chapter edit: edit a chapter in html with the WYSIWYG (What you see is what you get) editor. Don't forget to save when you're done. If you're more comfortable with markdown, you can also use the “update as Markdown” interface of this window.
-
Manage Chapter: Add, delete, rename, reorder chapters
About code blocks in interactive mode
Code blocks are, on purpose, not editable in Interactive mode. You should switch to Markdown mode if you want to edit these elements.
Options
The idea of this tab is that non-tech people don't want to enter too many technical details, hence they have “textual” content to see. If you want to dig into the tech, two tabs can be used to do that.
-
Global: edit some global options with a friendly UI
-
Edit options manually: change the options of Index.Rmd, _output.yml and _bookdown.yml just as if you were in any editor
-
Edit any file: open an editor for any file contained in same directory as the index.Rmd. ## Design
Two things can be edited in this tab:
-
CSS: edit, create and delete CSS files
-
Highlight: change the book syntax highlighting
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.