Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.46 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.46 KB
Raw

MonoGame.github.io

This repository contains the source code for the MonoGame website. If you're looking for the documentation, visit the Documentation repository.

Prerequisites

To build and run the MonoGame website locally, you will need

Running the Website Locally

The MonoGame website is built using 11ty (Eleventy), a static site generator. To start working with the site on your local machine, follow these steps:

  1. Clone this repository

    git clone https://github.com/MonoGame/monogame.github.io.git

  2. Install npm dependencies

    In the root directory of the cloned repository, run:

    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

    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:

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 file for more details.