Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msys2/msys2.github.io
The MSYS2 homepage
https://github.com/msys2/msys2.github.io
Last synced: about 2 months ago
JSON representation
The MSYS2 homepage
- Host: GitHub
- URL: https://github.com/msys2/msys2.github.io
- Owner: msys2
- License: other
- Created: 2014-02-23T00:53:02.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T20:42:59.000Z (4 months ago)
- Last Synced: 2024-05-23T02:06:51.619Z (4 months ago)
- Language: CSS
- Homepage: https://www.msys2.org
- Size: 31.8 MB
- Stars: 2,115
- Watchers: 53
- Forks: 268
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome - msys2/msys2.github.io - The MSYS2 homepage (CSS)
README
# MSYS2 Website
## Overview
This website is written in Markdown and gets built to a static website using
[mkdocs](https://www.mkdocs.org/) and a modified version of the [mkdocs-material
theme](https://squidfunk.github.io/mkdocs-material). Any new commits to the
`main` branch will auto deploy to [GitHub pages](https://pages.github.com) using
[a GitHub action](https://github.com/actions/deploy-pages). The resulting
website is reachable under https://msys2.github.io and https://www.msys2.org.
Changes to the `main` branch usually take a minute or two until they are live.## Development
For small changes:
* Just use the online editor on GitHub and use the Markdown preview to inspect your changes
* Open a PR with your changes in case you don't have commit rights
* **Note:** The Markdown dialect and extensions understood by mkdocs and GitHub is
slightly different, so double check that the deployed website matches what you
expected
* **Note:** Every page on the website has a small "edit" icon in the top right corner which leads you straight to the online editor for that pageFor larger changes:
* `poetry install`
* `poetry run mkdocs serve`
* Access http://127.0.0.1:8000 - any changes to the sources should be
immediately visible in your browser
* Open a PR with your changes or just push them if you have commit rights### Link Checker
Run `./linkcheck.sh` to check for broken links. This script uses
[lychee](https://github.com/lycheeverse/lychee) and requires Docker to be
installed.