/match-documentation

Primary LanguageShellMIT LicenseMIT

The Match Documentation Website

This repository contains the code for creating the Match Documentation website. The Match Documentation website is created using the Hugo Book Template Theme and Wowchemy.

General Instructions

When you change a file and push your changes then the website will be automatically updated. You can find the latest version of the website on https://cpjku-documentation.netlify.app.

To view your changes locally use:

cd To/repository/Parent/directory/match-documentation/

hugo server

You can copy //localhost:1313/ in your browser to visualize locally the website and your ongoing changes.

Homebrew and MacPorts can be used to install hugo on Linux or Mac Respectively. See install if you are running Windows or you are running into errors.

brew install hugo
# or
port install hugo

Repository Organization

Content

In the folder content of the repository one can find the complete contents of the created website. This is the principal folder that should be mainly used and changed.
Every folder in this directory page should correspond to a Page accessible by the main page. Following this logic, there is a folder home for the main (welcome) page, a folder about match documentation, a folder about partitura documentation or redirection, and also could have matchmaker documentation or other projects in distinct folders.

Assets

The asset folder contains media such as icons, logos, etc.

Date and Resources

These folder contain Theme related information that is used automatically to create a hugo style website. They

Config

The config folder concerns language and other configuration related settings.

Theme, Wowchemy & Hugo related Information

Check out the latest demo of what you'll get in less than 10 minutes, or view the showcase.