Skip to content

INITIALISE-EU-project/guidelines

Repository files navigation

INITIALISE EU Project: guidelines

Logo

The website is automatically rendered. Here you find instructions on how to edit the website.

Troubleshooting: Contact Leo Lahti in case of problems.

Rendering the book

Option 1: github web browser

Edit the files directly through web browser in Github.

The website is automatically rendered from the Rmd files (files ending with .Rmd). The chapters order is defined in the file _bookdown.yml. Navigate to the file that you want to edit, click on the pen figure around the top right corner of the page (next to the "Raw" and "Blame" buttons), then edit the file and commit the changes (the Commit button at the bottom of the page).

An external server detects the update and renders the website. If the build is successful, it will trigger a new process in Github Actions. It usually takes 1-2 minutes that the changes appear on the website. The changes will not become visible if the build fails.

Option 2: command line

You can edit this website via Github.

  1. Clone the repository

  2. Edit the files

  3. Generate and view the book locally in R with:

bookdown::serve_book()

You can render the book locally in R with:

bookdown::render_book()
  1. Commit and push your changes to Github.

Automation for the process can be added.

About

Initialise EU Project guidelines

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published