# netboot.xyz documentation

[![Build Status](https://github.com/netbootxyz/netboot.xyz-docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/netbootxyz/netboot.xyz-docs/actions/workflows/deploy.yml)
[![Discord](https://img.shields.io/discord/425186187368595466)](https://discord.gg/An6PA2a)

This is the main documentation repository for [netboot.xyz](https://netboot.xyz) which is built upon [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

The contents of this repo are deployed automatically to netboot.xyz upon being merged.

## Development and Contributions

Contributions to the documentation are always welcome.  Please feel free to open pull requests to this repo if you see a bug, want to improve the existing documentation, or want to add some how-tos to help others.  

Ultimately this site is for helping others boot operating systems and using network booting related tools, so any documenation or articles that might be able to help others are welcome.

## Installation

```console
yarn install
```

## Local Development

```console
yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.