Skip to content
The MSYS2 homepage
Branch: source
Clone or download

Latest commit

Latest commit 5ff3bfd Mar 27, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows New mkdocs based website Mar 26, 2020
docs More list fixes Mar 27, 2020
.gitignore New mkdocs based website Mar 26, 2020
README.md README: Given an overview of the deployment process and extend the de… Mar 27, 2020
mkdocs.yml Add some links to github/gitter/twitter Mar 27, 2020
requirements.txt New mkdocs based website Mar 26, 2020

README.md

MSYS2 Website

Overview

This website is written in Markdown and gets built to a static website using mkdocs and a modified version of the mkdocs-material theme. The main branch of this repo is the source branch and any new commits will auto deploy a new build to the master branch using a GitHub action. The master branch is connected to GitHub pages and is reachable under https://msys2.github.io and https://www.msys2.org. Changes to the source 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 page

For larger changes:

  • python3 -m venv _venv
  • source _venv/bin/activate
  • python -m pip install -r requirements.txt
  • python -m 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
You can’t perform that action at this time.