Giter VIP home page Giter VIP logo

website's Introduction

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.

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

Preparing the 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 mkdocs mkdocs[i18n] mkdocs-material

Obtaining the sources

Clone the repository using Git:

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

Editing the contents

Make the edits you want using any text editor you like (e.g. Visual Studio Code supports highlighting and previewing Markdown out of the box and so does Atom).

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 edits

Once the build is successful, add the edited files using Git and commit the changes:

$ git add docs
$ git commit

Publishing the edits

To publish your edits in source form, push them to GitHub:

$ git push

Publishing the website

Once you have confirmed that the build is successful, push the built contents to GitHub using the MkDocs gh-deloy command:

$ mkdocs gh-deploy

Wait a few minutes until GitHub Pages finishes building the new site from the changes you just pushed and then visit group.miletic.net to make sure that your changes are visible.

That's all, folks!

website's People

Contributors

vedranmiletic avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.