Skip to content

gaseri/website

Repository files navigation

😎 Group for apps and services on exascale research infrastructure (GASERI) website

The group is interested in scientific software development, high-performance computers, cloud computing, and the use of free open-source software in the development of applications and services for supercomputers and cloud platforms, specifically in the application of exascale computing to solve problems in computational biochemistry and related fields. Visit the group website for more information.

License

The contents of the website are licensed under Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0), except teaching materials in Croatian under /hr/nastava/materijali/, teaching materials in English under /en/teaching/materials/, and tutorials in English under /en/tutorials/, which are licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).

Prerequisites

Editing the website contents requires at least the basic knowledge of writing Markdown in MkDocs.

Obtaining the sources

Clone the repository using Git:

$ git clone https://github.com/gaseri/website.git
$ cd website

Editing the contents

Make the changes you want using any text editor you like. Popular choices include Visual Studio Code, which supports highlighting and previewing Markdown out of the box, VSCodium, the community-driven and freely-licensed binary distribution of VS Code, IntelliJ IDEA with the bundled Markdown plugin, Markdown Mode for GNU Emacs, and Markdown Vim Mode.

Preparing the build environment

The website is built using MkDocs and Material for MkDocs. Make sure that you have Python and pip installed on your system; these two packages can usually be obtained via the operating system's package manager (e.g. APT, DNF, Pacman, Zypper, FreeBSD pkg, Homebrew, or Windows Package Manager).

Once Python and pip are successfully set up, start by installing the required Python packages using the pip command:

$ pip install -r requirements.txt

By the way, if you are using Arch Linux, you can alternatively use mkdocs and mkdocs-material from Arch User Repository (AUR). Similarly, if you are using FreeBSD, you can use py-mkdocs and py-mkdocs-material from Ports. These packages are mostly kept in sync with the upstream releases.

Previewing the website

To open a local web server that will serve the website contents for previewing, use the MkDocs's serve command:

$ mkdocs serve

Building the website

Build the website using MkDocs's build command (any remains of the previous build will be cleaned up automatically):

$ mkdocs build

If the build was unsuccessful, fix the errors and repeat the building process.

Saving the changes

Confirm that the website can be successfully built, add the changed files using Git, and commit the changes:

$ git add docs
$ git commit

Publishing the changes

To publish the changes, push them to GitHub:

$ git push

Wait a few minutes until GitHub Pages finishes building the new site, including the changes you just pushed. Visit group.miletic.net to make sure that your changes are visible.

Note: The official MkDocs approach, which we don't use, is to push the built contents to GitHub using the MkDocs's GitHub deploy command (mkdocs gh-deploy).

That's all, folks!

Built with Material for MkDocs

About

Group for Applications and Services on Exascale Research Infrastructure (GASERI) website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages