Giter Club home page Giter Club logo

docs's Introduction

The Match Documentation Website

This repository contains the code for creating the CPJKU Documentation website. You can find the latest version of the website on https://cpjku.github.io/docs/.

General Instructions

When you change a file and push your changes then the website will be automatically updated. The website is created using the Hugo Book Template Theme and Wowchemy. A github action builds this page to the gh-pages branch.

Hugo extended 0.83.1 is required to build this website. You can download it here

To view your changes locally use:

cd To/repository/Parent/directory/docs/

hugo server

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

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

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.