Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/monogame/monogame.github.io
MonoGame Website
https://github.com/monogame/monogame.github.io
monogame website
Last synced: about 2 months ago
JSON representation
MonoGame Website
- Host: GitHub
- URL: https://github.com/monogame/monogame.github.io
- Owner: MonoGame
- License: other
- Created: 2023-09-23T12:36:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-03T20:44:17.000Z (about 2 months ago)
- Last Synced: 2024-11-03T21:26:33.540Z (about 2 months ago)
- Topics: monogame, website
- Language: Nunjucks
- Homepage: https://www.monogame.net
- Size: 65 MB
- Stars: 24
- Watchers: 4
- Forks: 14
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# MonoGame.github.io
This repository contains the source code for the [MonoGame](https://monogame.net) website. If you're looking for the documentation, visit the [Documentation](https://github.com/monogame/docs.monogame.github.io) repository.
## Prerequisites
To build and run the MonoGame website locally, you will need
- [Node.js and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
## Running the Website Locally
The MonoGame website is built using [11ty (Eleventy)](https://www.11ty.dev/), a static site generator. To start working with the site on your local machine, follow these steps:
1. **Clone this repository**
```sh
git clone https://github.com/MonoGame/monogame.github.io.git
```
2. **Install npm dependencies**
In the root directory of the cloned repository, run:
```sh
npm install
```
3. **Start the development server**
To serve the site locally with hot-reloading, which allows you to see changes in real-time, use the following command
```sh
npm run dev
```
This will spin up a local server, the address of which will be shown in the console.
## Building the Site for Production
To generate a production-ready build of the site, run:
```sh
npm run build
```
This will generate the static HTML file in the `_site` directory.
## LICENSE
The MonoGame project is under the Microsoft Public License except for a few portions of the code. See the [LICENSE](LICENSE) file for more details.