Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inbo/tutorials
A collection of technical tutorials for INBO (and anyone who's interested)
https://github.com/inbo/tutorials
r tutorial
Last synced: 2 months ago
JSON representation
A collection of technical tutorials for INBO (and anyone who's interested)
- Host: GitHub
- URL: https://github.com/inbo/tutorials
- Owner: inbo
- License: cc-by-4.0
- Created: 2016-09-29T14:56:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T16:49:32.000Z (2 months ago)
- Last Synced: 2024-11-07T17:43:33.663Z (2 months ago)
- Topics: r, tutorial
- Language: HTML
- Homepage: https://tutorials.inbo.be/
- Size: 90.2 MB
- Stars: 22
- Watchers: 15
- Forks: 9
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tutorials
[](https://github.com/inbo/tutorials/actions/workflows/deploy-gh-pages.yml)
This repository contains the source files for the [INBO tutorials website](https://inbo.github.io/tutorials/): a collection of instructions on the use, installation and development of research software at the Research Institute of Nature and Forest (INBO).
## Adding content
New tutorials should go in a new directory in `content/tutorials`. Use plain markdown files (`.md`) as much a possible. Use Rmarkdown files (`.Rmd`) when calculations in R are required. For more information about creating a new tutorial, check the [create tutorial](https://inbo.github.io/tutorials/create_tutorial/) page.
## Reviewing the website in a pull request (before merging)
Thanks to GitHub Actions, an artifact (=zip file) of the rendered website is now automatically created on each pull request.
[Learn more](https://github.com/inbo/tutorials/blob/master/.github/pull_request_template.md#previewing-the-pull-request) about showing the development website of a pull request in your browser.
## Building the site
The technology used to create the website is [Hugo](https://gohugo.io/), a static website generator. Hugo will process all the markdown files - ignoring Rmd, which is why these need to be knit beforehand - and create the necessary files (html, css, js) for the website. These are served from the [`gh-pages` branch](https://github.com/inbo/tutorials/tree/gh-pages).
### GitHub actions
[GitHub actions](https://github.com/features/actions) will automatically run the steps above ([install Hugo, download theme, run Hugo, deploy website](.github/workflows/deploy-gh-pages.yml)) for every commit to the master branch. You will see in the [actions page](https://github.com/inbo/tutorials/actions/workflows/deploy-gh-pages.yml) if the build was successful. If not, check the logs to figure out what went wrong.
### Building the site on your local computer
1. [Install hugo](https://gohugo.io/getting-started/installing/)
2. Clone the tutorials repository
3. In the cloned tutorials directory, install the theme with `git clone https://github.com/MunifTanjim/minimo.git --branch v2.9.0 themes/minimo`
4. Build and serve the site with `hugo server`
For more information, see [Hugo's getting started documentation](https://gohugo.io/getting-started/usage/).
### Customizing the theme
The tutorials website makes use of the Hugo theme [minimo](https://themes.gohugo.io/minimo/). This theme is not included in the repository, but [downloaded by GitHub pages](https://github.com/inbo/tutorials/blob/262f305ef66fd4fc46ef7b2a9dce36cd2ad3e0d9/.github/workflows/deploy-gh-pages.yml#L18-L23) at build time. This avoids clutter and changes to the theme itself. To customize the theme:
1. Browse the `layouts` directory in the [minimo repository](https://github.com/MunifTanjim/minimo/tree/master/layouts) to see which template file you want to customize
2. Copy the template file to the same path in the [`layouts`](layouts/) directory of this repository
3. Edit the file to the desired effect. E.g. [this update](https://github.com/inbo/tutorials/blob/b122758ef8d98977e51335bf227a2cf8c1f6bbd7/layouts/partials/entry/meta.html#L15-L16) to the [original minimo file](https://github.com/MunifTanjim/minimo/blob/4436676dd44c767faaa4fa85f8a24527ce61ba81/layouts/partials/entry/meta.html#L15) adds a "edit this page" link for every page.
4. Hugo will now use your customized file instead of the default theme file.
For more information, see the [Hugo theme customization documentation](https://gohugo.io/getting-started/quick-start/#step-6-customize-the-theme). To test theme customization, it is best to build the site on your local computer (see above).
## Contributors
[List of contributors](https://github.com/inbo/tutorials/graphs/contributors)
## License
[Creative Commons Attribution](https://creativecommons.org/licenses/by/4.0/) for [content](content) / [MIT License](https://github.com/inbo/tutorials/blob/master/LICENSE) for source code.