https://github.com/msys2/msys2.github.io

The MSYS2 homepage
https://github.com/msys2/msys2.github.io

Last synced: 3 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-03-02T19:35:15.000Z (4 months ago)
• Last Synced: 2024-03-11T02:16:24.599Z (3 months ago)
• Language: CSS
• Homepage: https://www.msys2.org
• Size: 31.6 MB
• Stars: 2,016
• Watchers: 52
• Forks: 253
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• awesome-five23 - msys2.github.io
• awesome - msys2/msys2.github.io - The MSYS2 homepage (CSS)
• awesome-stars - msys2/msys2.github.io - The MSYS2 homepage (CSS)
• awesome-stars - msys2.github.io

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 page

For 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