https://github.com/mingw-w64/mingw-w64.github.io

mingw-w64.net web page contents (The new web page)
https://github.com/mingw-w64/mingw-w64.github.io

Last synced: 13 days ago
JSON representation

mingw-w64.net web page contents (The new web page)

• Host: GitHub
• URL: https://github.com/mingw-w64/mingw-w64.github.io
• Owner: mingw-w64
• License: other
• Created: 2021-07-09T16:21:58.000Z (over 3 years ago)
• Default Branch: source
• Last Pushed: 2024-10-16T18:46:54.000Z (28 days ago)
• Last Synced: 2024-10-18T17:28:26.146Z (26 days ago)
• Language: CSS
• Homepage:
• Size: 12.9 MB
• Stars: 594
• Watchers: 16
• Forks: 1,310
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# MinGW-w64 Website

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). The main branch of this

repo is the `source` branch and any new commits will auto deploy a new build to

the `main` branch using [a GitHub

action](https://github.com/peaceiris/actions-gh-pages). The `main` branch is

connected to [GitHub pages](https://pages.github.com) and is reachable under

https://mingw-w64.github.io and https://www.mingw-w64.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:

* `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