Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manoskary/match-documentation
https://github.com/manoskary/match-documentation
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/manoskary/match-documentation
- Owner: manoskary
- License: mit
- Created: 2021-09-15T16:35:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-03T11:51:40.000Z (over 2 years ago)
- Last Synced: 2024-11-04T08:38:11.596Z (2 months ago)
- Language: Shell
- Size: 622 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](https://cpjku-documentation.netlify.app).
To view your changes locally use:
```shell
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](https://gohugo.io/getting-started/installing) if you are running Windows or you are running into errors.
```shell
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](https://book-starter.netlify.app/) of what you'll get in less than 10 minutes, or [view the showcase](https://wowchemy.com/user-stories/).
- 👉 [**Get Started**](https://wowchemy.com/templates/)
- 📚 [View the **documentation**](https://wowchemy.com/docs/)
- ⬆️ **Updating Wowchemy?** View the [Update Guide](https://wowchemy.com/docs/update/) and [Release Notes](https://wowchemy.com/updates/)