Contour/README.md

FluxNodes

The image shown is a concept

Support Center and Documents

All articles for Flux's support center is located at /src/content/docs/support/

All documents such as Terms of Service or when polices need to be added, they should be located at /src/content/docs/.

Writing an Article

All articles are written in Markdown, do make sure you're adding the markdown file to the appropriate category folder.

Articles, at the least, should have a title and last updated:

---
title: Title of Article
lastUpdated: 2024-03-15
---

Frontmatter

In each article, there are plenty of options to add to the frontmatter which can be used to add stuff such as banners, table of contents, and other variables.

Banners

To add a banner, add the following:

---
banner:
  content: |
    This is an example of a banner.
    <a href="https://fluxnodes.net/">Important Link</a>
---

Table of Contents

If for whatever reason you want to enable the table of contents for an article, you can enable by adding:

---
tableOfContents: true
---

Badge

Badges can be used to add a little text next to the article name like "New" or "Outdated".

Varients: note | tip | caution | danger | success | default

---
sidebar:
  badge:
    text: Outdated
    variant: caution
---

Slug

If you need to override the URL, you can use slug.

---
slug: /support/minecraft/world-management
---

Layouts

This should only be set for documents such as Terms of Service and polices.

Starlight provides two options: doc | splash

The doc layouts includes both the sidebar and content, useful for articles. The splash layout removes the sidebar.

---
template: splash
---

Development

Requirements

• Bun
• NodeJS 20 or later

Install Packages

Installing packages is required to start run and to build the website, run:

bun install

Run

To start running the website on a port, run:

bun dev

Production

Build Static

To build the website in static mode, run:

bun build

Server Side Rendering

To run the website in server side rendering mode, run:

bun start

Docker

This website is Docker ready!

Build the Docker image, run:

docker build -t fluxnodes.net .

Then, to run:

docker run -d -p 2000:2000 fluxnodes.net

or use the already provided Docker Compose file:

docker compose up -d

sudo might be required on some systems to run Docker commands.