mirror of
https://github.com/sbrl/Minetest-WorldEditAdditions.git
synced 2024-11-19 21:53:44 +01:00
Start working on documentation website, but it's not finished yet
This commit is contained in:
Starbeamrainbowlabs
parent
9cb746e86a
commit
117002f9e9
4
.docs/.eleventy.js
Normal file
4
.docs/.eleventy.js
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
module.exports = function(eleventyConfig) {
|
||||||
|
eleventyConfig.addPassthroughCopy("images");
|
||||||
|
eleventyConfig.addPassthroughCopy("theme.css");
|
||||||
|
}
|
||||||
6
.docs/Changelog.11tydata.json
Normal file
6
.docs/Changelog.11tydata.json
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"layout": "theme.njk",
|
||||||
|
"title": "Changelog",
|
||||||
|
"tags": "navigable",
|
||||||
|
"date": "2002-01-01"
|
||||||
|
}
|
||||||
1
.docs/Changelog.md
Symbolic link
1
.docs/Changelog.md
Symbolic link
@ -0,0 +1 @@
|
|||||||
|
../CHANGELOG.md
|
||||||
6
.docs/Reference.11tydata.json
Normal file
6
.docs/Reference.11tydata.json
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"layout": "theme.njk",
|
||||||
|
"title": "Reference",
|
||||||
|
"tags": "navigable",
|
||||||
|
"date": "2001-01-01"
|
||||||
|
}
|
||||||
1
.docs/Reference.md
Symbolic link
1
.docs/Reference.md
Symbolic link
@ -0,0 +1 @@
|
|||||||
|
../Chat-Command-Reference.md
|
||||||
34
.docs/_includes/theme.njk
Normal file
34
.docs/_includes/theme.njk
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
---
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset='utf-8' />
|
||||||
|
<title>{{ title }} • WorldEditAdditions</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="/theme.css" />
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<nav>
|
||||||
|
<h1>
|
||||||
|
<img src="https://starbeamrainbowlabs.com/images/placeholder/?width=64&height=64&text=%20?%20" alt="Placeholder logo" class="icon medium" />
|
||||||
|
WorldEditAdditions
|
||||||
|
</h1>
|
||||||
|
<ul>
|
||||||
|
{% for navitem in collections.navigable %}
|
||||||
|
<li {% if page.url == navitem.url %}aria-current="page"{% endif %}>
|
||||||
|
<a href="{{ navitem.url }}" class="nav">{{ navitem.data.title }}</a>
|
||||||
|
</li>
|
||||||
|
{% endfor %}
|
||||||
|
<li><a href="https://github.com/sbrl/Minetest-WorldEditAdditions/" class="nav">GitHub</a></li>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
{{ content | safe }}
|
||||||
|
|
||||||
|
<footer>
|
||||||
|
<p>Built with ❤ by <a href="https://starbeamrainbowlabs.com/">Starbeamrainbowlabs</a></p>
|
||||||
|
<p>Licensed under <a href="https://www.mozilla.org/en-US/MPL/2.0/">Mozilla Public Licence 2.0</a> (<a href="https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2)">tldr</a>)</p>
|
||||||
|
</footer>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
BIN
.docs/images/banner-main.jpeg
Normal file
BIN
.docs/images/banner-main.jpeg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 936 KiB |
BIN
.docs/images/conv-layers.png
Normal file
BIN
.docs/images/conv-layers.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 317 KiB |
BIN
.docs/images/forest.png
Normal file
BIN
.docs/images/forest.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 474 KiB |
BIN
.docs/images/maze2d-alt.png
Normal file
BIN
.docs/images/maze2d-alt.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 341 KiB |
BIN
.docs/images/maze2d.png
Normal file
BIN
.docs/images/maze2d.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 434 KiB |
BIN
.docs/images/torus-bonemeal.png
Normal file
BIN
.docs/images/torus-bonemeal.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 354 KiB |
50
.docs/index.html
Normal file
50
.docs/index.html
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
---
|
||||||
|
layout: theme.njk
|
||||||
|
title: Welcome
|
||||||
|
tags: navigable
|
||||||
|
date: 2000-01-01
|
||||||
|
---
|
||||||
|
|
||||||
|
<section class="bigbox" style="--bg: url(/images/banner-main.jpeg)">
|
||||||
|
<h1>WorldEditAdditions</h1>
|
||||||
|
<p><em>Extra tools and commands to extend <a href="https://github.com/Uberi/Minetest-WorldEdit">WorldEdit</a> for <a href="https://www.minetest.net/">Minetest</a></em></p>
|
||||||
|
<p>If you can dream of it, it probably belongs here!</p>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="features-large">
|
||||||
|
<figure>
|
||||||
|
<img src="/images/maze2d-alt.png" alt="A green 2D hedge maze, made with the //maze command" />
|
||||||
|
<figcaption>
|
||||||
|
<p>Use <code>//maze</code> and <code>//maze3d</code> to generate customisable mazes in 2 or 3 dimensions.</p>
|
||||||
|
<p>Customise the path sizing for additional artistic control.</p>
|
||||||
|
</figcaption>
|
||||||
|
</figure>
|
||||||
|
|
||||||
|
<figure>
|
||||||
|
<img src="/images/forest.png" alt="A forest of orange and lemon trees from the cooltrees mod, along with some bushes from Minetest Game." />
|
||||||
|
<figcaption>
|
||||||
|
<p>Save time by creating instant forests with <code>//forest</code>.</p>
|
||||||
|
<p>Artibrary mixes of saplings are supported too as a weighted list.</p>
|
||||||
|
</figcaption>
|
||||||
|
</figure>
|
||||||
|
|
||||||
|
<figure>
|
||||||
|
<img src="/images/conv-layers.png" alt="A small mountain smoothed with //smoothadv and topped with snow with //overlay" />
|
||||||
|
<figcaption>
|
||||||
|
<p>Unlock a continuously growing library of commands, such as <code>//smoothadv</code> for easy terrain smoothing, and <code>//overlay</code> for overlaying a node on top of terrain.</p>
|
||||||
|
<p>Many more commands are waiting to be discovered, including <code>//torus</code>, <code>//bonemeal</code>, and <code>//scale</code>.</p>
|
||||||
|
</figcaption>
|
||||||
|
</figure>
|
||||||
|
|
||||||
|
<figure>
|
||||||
|
<img src="/images/torus-bonemeal.png" alt="A dirt torus with a grassy top, and a meadow of grass/flowers. Demonstrates //layers and //bonemeal. Doesn't have much to do with the sentences below - I just thought it looked nice as meta commands are difficult to find a good picture for." />
|
||||||
|
<figcaption>
|
||||||
|
<p>Powerful meta commands such as <code>//multi</code> for executing multiple commands at once and <code>//subdivide</code> for running commands on areas of virtually unlimited size enable convenience and enhance flexibility.</p>
|
||||||
|
</figcaption>
|
||||||
|
</figure>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Potentially we might want some inspiration from https://codepen.io/emared/pen/gWGBLR here -->
|
||||||
6742
.docs/package-lock.json
generated
Normal file
6742
.docs/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
23
.docs/package.json
Normal file
23
.docs/package.json
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
{
|
||||||
|
"name": "worldeditadditions",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "Documentation website for WorldEditAdditions",
|
||||||
|
"main": "index.js",
|
||||||
|
"private": true,
|
||||||
|
"scripts": {
|
||||||
|
"test": "echo \"No tests have been implemented yet\""
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/sbrl/Minetest-WorldEditAdditions.git"
|
||||||
|
},
|
||||||
|
"author": "Starbeamrainbowlabs",
|
||||||
|
"license": "MPL-2.0",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/sbrl/Minetest-WorldEditAdditions/issues"
|
||||||
|
},
|
||||||
|
"homepage": "https://github.com/sbrl/Minetest-WorldEditAdditions#readme",
|
||||||
|
"devDependencies": {
|
||||||
|
"@11ty/eleventy": "^0.12.1"
|
||||||
|
}
|
||||||
|
}
|
||||||
219
.docs/theme.css
Normal file
219
.docs/theme.css
Normal file
@ -0,0 +1,219 @@
|
|||||||
|
/* Base CSS */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This CSS file contains (for me) logical style defaults that are easy to read.
|
||||||
|
*
|
||||||
|
* This file is quite often used as a starting point for other projects.
|
||||||
|
*
|
||||||
|
* Todo:
|
||||||
|
* <button>
|
||||||
|
* <inputs>
|
||||||
|
* <progress>
|
||||||
|
* <meter>
|
||||||
|
*/
|
||||||
|
|
||||||
|
:root {
|
||||||
|
--bg-main: #8ABEF6;
|
||||||
|
--bg-bright: #38871e;
|
||||||
|
--bg-alt: #3F57B4;
|
||||||
|
--bg-transcluscent-slight: rgba(255, 255, 255, 0.1);
|
||||||
|
--bg-transcluscent: rgba(255, 255, 255, 0.8);
|
||||||
|
|
||||||
|
--text-main: #3F57B4;
|
||||||
|
--text-bright: #efefef;
|
||||||
|
--text-alt: #38871e;
|
||||||
|
|
||||||
|
--highlight: hsl(353, 100%, 36%);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* @media (prefers-color-scheme: dark) {
|
||||||
|
:root {
|
||||||
|
--bg-main: #232323;
|
||||||
|
--bg-bright: black;
|
||||||
|
--bg-transcluscent: rgba(50, 50, 50, 0.5);
|
||||||
|
|
||||||
|
--text-main: #f3f3f3;
|
||||||
|
}
|
||||||
|
} */
|
||||||
|
|
||||||
|
/* rem is relative to the html element, and em is relative to the current element. */
|
||||||
|
html { font-size: 100%; }
|
||||||
|
|
||||||
|
body
|
||||||
|
{
|
||||||
|
margin: 0;
|
||||||
|
font-family: sans-serif; /* Serif is awful :( */
|
||||||
|
|
||||||
|
background: var(--bg-main); /* Don't forget to update the @page one too for paged media */
|
||||||
|
color: var(--text-main);
|
||||||
|
}
|
||||||
|
|
||||||
|
title { string-set: page-title content(text); }
|
||||||
|
|
||||||
|
/* Special tweaks for paged media (e.g. PDFs) */
|
||||||
|
@page {
|
||||||
|
font-family: sans-serif;
|
||||||
|
background: var(--bg-main); /* Set the background colour to cover the whole page */
|
||||||
|
|
||||||
|
@top-right {
|
||||||
|
content: "By Starbeamrainbowlabs";
|
||||||
|
opacity: 0.6;
|
||||||
|
}
|
||||||
|
@bottom-right {
|
||||||
|
content: "Page " counter(page) " of " counter(pages);
|
||||||
|
opacity: 0.6;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
nav {
|
||||||
|
background: var(--bg-bright);
|
||||||
|
display: flex;
|
||||||
|
align-items: baseline;
|
||||||
|
font-size: 1.1em;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
nav h1 {
|
||||||
|
background: var(--bg-alt);
|
||||||
|
margin: 0;
|
||||||
|
padding: 0.5em;
|
||||||
|
font-size: 1.2em;
|
||||||
|
color: var(--text-bright);
|
||||||
|
}
|
||||||
|
nav ul {
|
||||||
|
flex: 1;
|
||||||
|
list-style-type: none;
|
||||||
|
margin: 0; padding: 0;
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-evenly;
|
||||||
|
}
|
||||||
|
nav ul li {
|
||||||
|
background: var(--bg-transcluscent-slight);
|
||||||
|
}
|
||||||
|
nav a {
|
||||||
|
display: inline-block;
|
||||||
|
padding: 1.2em 3em;
|
||||||
|
text-decoration: none;
|
||||||
|
font-weight: bold;
|
||||||
|
color: var(--text-bright);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* A small tweak to things more responsive */
|
||||||
|
iframe, object, embed, img, table
|
||||||
|
{
|
||||||
|
max-width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Turn the user's cursor into a hand when over things they can click */
|
||||||
|
button, summary
|
||||||
|
{
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
th, td
|
||||||
|
{
|
||||||
|
margin: 4px 6px;
|
||||||
|
padding: 4px 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
a { font-weight: bold; }
|
||||||
|
/* a:not(.nav) { color: hsl(208, 67%, 40%); }
|
||||||
|
a:not(.nav):hover { color: hsl(214, 67%, 50%); }
|
||||||
|
a:not(.nav):active, a:focus { color: hsl(214, 87%, 60%); } */
|
||||||
|
a:not(.nav):visited { color: hsl(240, 77%, 60%); }
|
||||||
|
|
||||||
|
pre { page-break-inside: avoid; break-inside: avoid; }
|
||||||
|
pre, code {
|
||||||
|
white-space: pre-wrap;
|
||||||
|
-moz-tab-size: 4;
|
||||||
|
tab-size: 4;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* todo add the rest of the textbox like inputs here */
|
||||||
|
input[type=text], input[type=number], textarea
|
||||||
|
{
|
||||||
|
margin: 3px 5px;
|
||||||
|
padding: 5px 8px;
|
||||||
|
|
||||||
|
background: var(--bg-bright);
|
||||||
|
border: 0;
|
||||||
|
border-radius: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* Utility / layout aids */
|
||||||
|
.float.left { float: left; }
|
||||||
|
.float.right { float: right; }
|
||||||
|
|
||||||
|
.flex { display: flex; }
|
||||||
|
.flex-1 { flex: 1; }
|
||||||
|
.flex-2 { flex: 2; }
|
||||||
|
.flex-3 { flex: 3; }
|
||||||
|
.flex-4 { flex: 4; }
|
||||||
|
.flex-5 { flex: 5; }
|
||||||
|
.flex-6 { flex: 6; }
|
||||||
|
|
||||||
|
.small-spacing { margin: 0.25em 0.35em; padding: 0.25em 0.35em; }
|
||||||
|
.med-spacing { margin: 0.45em 0.65em; padding: 0.45em 0.65em; }
|
||||||
|
.high-spacing { margin: 1em 1.25em; padding: 1em 1.25em; }
|
||||||
|
|
||||||
|
.text-left { text-align: left; }
|
||||||
|
.text-centre { text-align: center; }
|
||||||
|
.text-right { text-align: right; }
|
||||||
|
|
||||||
|
.small-text { font-size: 0.8rem; }
|
||||||
|
.medium-text { font-size: 1rem; }
|
||||||
|
.large-text { font-size: 1.3rem; }
|
||||||
|
|
||||||
|
.bold-text { font-weight: bolder; }
|
||||||
|
|
||||||
|
.block { display: block; }
|
||||||
|
.inline { display: inline; }
|
||||||
|
.inline.block { display: inline-block; }
|
||||||
|
|
||||||
|
.invisilink { text-decoration: none; color: inherit; }
|
||||||
|
.invisilist { list-style-type: none; margin: 5px; padding: 5px; }
|
||||||
|
|
||||||
|
.icon { vertical-align: middle; }
|
||||||
|
.icon.tiny { max-width: 1em; max-height: 1em; }
|
||||||
|
.icon.small { max-width: 1.25em; max-height: 1.25em; }
|
||||||
|
.icon.medium { max-width: 2em; max-height: 2em; }
|
||||||
|
.icon.large { max-width: 5em; max-height: 5em; }
|
||||||
|
|
||||||
|
.img-text-middle{ vertical-align: middle; }
|
||||||
|
|
||||||
|
|
||||||
|
.bigbox {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
align-items: center; justify-content: center;
|
||||||
|
background: content-box linear-gradient(var(--bg-transcluscent), var(--bg-transcluscent)),
|
||||||
|
var(--bg) center / cover;
|
||||||
|
height: 80vh;
|
||||||
|
padding: 0 5em 0 5em;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
.bigbox h1 {
|
||||||
|
margin-top: 0;
|
||||||
|
font-size: 3em;
|
||||||
|
color: var(--text-alt);
|
||||||
|
}
|
||||||
|
.bigbox :last-child { margin-bottom: 7em; }
|
||||||
|
|
||||||
|
.features-large {
|
||||||
|
margin: 3em 0;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: row;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
justify-content: space-evenly;
|
||||||
|
}
|
||||||
|
.features-large figure {
|
||||||
|
background: var(--bg-transcluscent);
|
||||||
|
margin: 0.1em;
|
||||||
|
padding: 1em;
|
||||||
|
max-width: 15em;
|
||||||
|
}
|
||||||
|
/* .features-large figure img {
|
||||||
|
max-width: 12em;
|
||||||
|
} */
|
||||||
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,3 +1,5 @@
|
|||||||
|
_site/
|
||||||
|
|
||||||
# Created by https://www.toptal.com/developers/gitignore/api/git
|
# Created by https://www.toptal.com/developers/gitignore/api/git
|
||||||
# Edit at https://www.toptal.com/developers/gitignore?templates=git
|
# Edit at https://www.toptal.com/developers/gitignore?templates=git
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user