https://github.com/easybuilders/easybuild-tutorial
EasyBuild tutorial
https://github.com/easybuilders/easybuild-tutorial
Last synced: 10 months ago
JSON representation
EasyBuild tutorial
- Host: GitHub
- URL: https://github.com/easybuilders/easybuild-tutorial
- Owner: easybuilders
- License: gpl-2.0
- Created: 2020-04-19T13:06:54.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-05-03T12:47:23.000Z (about 3 years ago)
- Last Synced: 2024-12-22T20:07:09.529Z (over 1 year ago)
- Language: Shell
- Homepage: https://tutorial.easybuild.io
- Size: 43.3 MB
- Stars: 2
- Watchers: 7
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome to the repository that hosts the sources of the official **[EasyBuild](https://easybuild.io)
tutorial**, see https://easybuilders.github.io/easybuild-tutorial.
## Basic info
* tutorial contents are located in ``docs/`` subdirectory
* [Markdown](https://daringfireball.net/projects/markdown) is used as syntax
## Getting started
This tutorial is rendered via [MkDocs](https://www.mkdocs.org/),
which makes it very easy to preview the result of the changes you make locally.
* First, install ``mkdocs``, including the `material` theme and additional plugins:
pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-redirects
* Start the MkDocs built-in dev-server to preview the tutorial as you work on it:
make preview
or
mkdocs serve
Visit http://127.0.0.1:8000 to see the local live preview of the changes you make.
* If you prefer building a static preview you can use ``make`` or ``mkdocs build``,
which should result in a ``site/`` subdirectory that contains the rendered documentation.
## Automatic updates
The rendered version of this tutorial at https://easybuilders.github.io/easybuild-tutorial
is automatically updated on every push to the ``main`` branch,
thanks to the GitHub Actions workflow defined in
[``.github/workflows/deploy.yml``](https://github.com/easybuilders/easybuild-tutorial/blob/main/.github/workflows/deploy.yml).
The [``gh-pages``](https://github.com/easybuilders/easybuild-tutorial/tree/gh-pages) branch in this repository contains the rendered version.
https://easybuilders.github.io/easybuild-tutorial will only be updated if the tests pass,
see GitHub Actions workflow defined in
[``.github.workflows/test.yml``](https://github.com/easybuilders/easybuild-tutorial/blob/main/.github/workflows/test.yml).
**Note**: **do *not* change the files in the ``gh-pages`` branch directly!**
All your changes will be lost the next time the ``main`` branch is updated...