diff --git a/docs/docs_templates/templates/home.jinja2 b/docs/docs_templates/templates/home.jinja2 index 9e2aa31f..aa02cf94 100644 --- a/docs/docs_templates/templates/home.jinja2 +++ b/docs/docs_templates/templates/home.jinja2 @@ -1,6 +1,11 @@ {% extends "base.jinja2" %} {% block content %} +
+
+ New Horizons Logo +
+

Welcome!

@@ -8,7 +13,33 @@
-

This is the official documentation for New Horizons

+

This is the official documentation for New Horizons

+
+
+
+
+

Getting Started

+
+
+
+
+

There is a template here if you want to release your own planet mod using configs. You can learn how the configs work by picking apart the Real Solar System mod or the New Horizons Examples mod.

+

Planets are created using a JSON file format structure, and placed in a folder called planets (or in any sub-directory of it) in the location where New Horizons is installed (by default this folder doesn't exist, you have to create it within the xen.NewHorizons directory).

+

To locate this directory, click the "⋮" symbol next to "New Horizons" in the Outer Wilds Mod Manager and then click "show in explorer" in the pop-up.

+
+
+
+
+
+ Click the three dots in the mod manager +
Click the ⋮
+
+
+
+
+ Create a new folder named "planets" +
Create a new folder named "planets"
+
{% endblock %} diff --git a/docs/generate.py b/docs/generate.py index d9c560a3..fffe139f 100644 --- a/docs/generate.py +++ b/docs/generate.py @@ -1,5 +1,7 @@ +import os from dataclasses import dataclass from pathlib import Path +from shutil import copytree from jinja2 import Environment, PackageLoader, select_autoescape from json_schema_for_humans.schema.schema_importer import get_schemas_to_render @@ -66,6 +68,20 @@ def template_override(template, intermediate_schema, inter_page): return rendered +print("Initializing") + + +if os.path.exists("out"): + os.rmdir("out") + +print("Copying Static") + +copytree("static", "out") + +os.makedirs("out/schemas") + +print("Rendering Pages") + for page in pages: page.render(schemas=schemas) diff --git a/docs/static/images/home/create_planets.png b/docs/static/images/home/create_planets.png new file mode 100644 index 00000000..a4ef1405 Binary files /dev/null and b/docs/static/images/home/create_planets.png differ diff --git a/docs/static/images/home/home_logo.png b/docs/static/images/home/home_logo.png new file mode 100644 index 00000000..8c5d212b Binary files /dev/null and b/docs/static/images/home/home_logo.png differ diff --git a/docs/static/images/home/mod_manager_dots.png b/docs/static/images/home/mod_manager_dots.png new file mode 100644 index 00000000..b17ee5a8 Binary files /dev/null and b/docs/static/images/home/mod_manager_dots.png differ diff --git a/docs/static/robots.txt b/docs/static/robots.txt new file mode 100644 index 00000000..c2a49f4f --- /dev/null +++ b/docs/static/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Allow: /