sbrl-github/Minetest-WorldEditAdditions
1
0
Fork 0
mirror of https://github.com/sbrl/Minetest-WorldEditAdditions.git synced 2024-11-22 07:23:00 +00:00
Code Issues Releases Wiki Activity

Add getting started section

Browse source 
Todo:

Completely revise the changelog / reference to use data & dynamicness, 
because we want to group headings into <section /> elements. That way it 
makes it *much* easier to implement a search feature, and also style it 
nicely too
This commit is contained in:
Starbeamrainbowlabs 2021-06-14 02:25:45 +01:00
parent 70b6adaa0d
commit ce41e8bc55
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
5 changed files with 48 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
.docs/.eleventy.js
View file

@ -46,7 +46,7 @@ async function shortcode_image_url(src) {
return data.url;
}
async function shortcode_image_urlpng(src) {
async function shortcode_image_urlpass(src) {
let target_dir = `./_site/img`;
if(!fs.existsSync(target_dir))
await fs.promises.mkdir(target_dir, { recursive: true });
@ -74,7 +74,8 @@ module.exports = function(eleventyConfig) {
// eleventyConfig.addPassthroughCopy("css");
eleventyConfig.addShortcode("image", shortcode_image);
eleventyConfig.addJavaScriptFunction("image", shortcode_image);
eleventyConfig.addShortcode("image_url", shortcode_image_url);
eleventyConfig.addNunjucksAsyncShortcode("image_urlpng", shortcode_image_urlpng);
// eleventyConfig.addNunjucksAsyncShortcode("image_url", shortcode_image_url);
eleventyConfig.addAsyncShortcode("image_url", shortcode_image_url);
eleventyConfig.addNunjucksAsyncShortcode("image_urlpass", shortcode_image_urlpass);
eleventyConfig.addPairedShortcode("gallerybox", shortcode_gallerybox);
}

2
.docs/_includes/theme.njk
View file

@ -21,7 +21,7 @@
<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>
<li><a href="https://github.com/sbrl/Minetest-WorldEditAdditions/" class="nav image"><img src="{% image_urlpass 'images/github.svg' %}" alt="GitHub" title="GitHub" /></a></li>
</ul>
</nav>
{{ content | safe }}

27
.docs/css/theme.css
View file

@ -43,14 +43,14 @@
} */
/* rem is relative to the html element, and em is relative to the current element. */
html { font-size: 100%; }
html { font-size: 100%; scroll-behavior: smooth; }
body
{
margin: 0;
font-family: sans-serif; /* Serif is awful :( */
background: url('{% image_urlpng "images/clouds.png" %}') center / cover fixed,
background: url('{% image_urlpass "images/clouds.png" %}') center / cover fixed,
var(--bg-main); /* Don't forget to update the @page one too for paged media */
color: var(--text-main);
}
@ -96,16 +96,18 @@ nav ul {
display: flex;
justify-content: space-evenly;
}
nav ul li {
background: var(--bg-transcluscent-slight);
}
nav a {
background: var(--bg-transcluscent-slight);
display: inline-block;
padding: 1.2em 3em;
text-decoration: none;
font-weight: bold;
color: var(--text-main);
}
nav a.image {
padding: 0.75em 1em 0.5em 1em;
}
nav img { max-height: 2em; }
/* A small tweak to things more responsive */
@ -227,16 +229,27 @@ footer {
flex-direction: column;
justify-content: flex-start;
}
.features-item.wide > :last-child {
/* .features-item.wide > :last-child {
flex: 1;
display: flex;
justify-content: flex-end;
flex-direction: column;
align-items: center;
} */
.panel-generic {
background: var(--bg-transcluscent);
margin: 2em;
padding: 1em;
box-shadow: 0.25em 0.25em 0.5em var(--shadow);
}
.cssbox-gallery {
.bigbutton-list {
list-style-type: none;
margin: 0;
padding: 1em 0;
display: flex;
justify-content: space-around;
}
.bigbutton {

6
.docs/images/github.svg Normal file
View file

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg width="256px" height="250px" viewBox="0 0 256 250" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid">
<g>
<path d="M128.00106,0 C57.3172926,0 0,57.3066942 0,128.00106 C0,184.555281 36.6761997,232.535542 87.534937,249.460899 C93.9320223,250.645779 96.280588,246.684165 96.280588,243.303333 C96.280588,240.251045 96.1618878,230.167899 96.106777,219.472176 C60.4967585,227.215235 52.9826207,204.369712 52.9826207,204.369712 C47.1599584,189.574598 38.770408,185.640538 38.770408,185.640538 C27.1568785,177.696113 39.6458206,177.859325 39.6458206,177.859325 C52.4993419,178.762293 59.267365,191.04987 59.267365,191.04987 C70.6837675,210.618423 89.2115753,204.961093 96.5158685,201.690482 C97.6647155,193.417512 100.981959,187.77078 104.642583,184.574357 C76.211799,181.33766 46.324819,170.362144 46.324819,121.315702 C46.324819,107.340889 51.3250588,95.9223682 59.5132437,86.9583937 C58.1842268,83.7344152 53.8029229,70.715562 60.7532354,53.0843636 C60.7532354,53.0843636 71.5019501,49.6441813 95.9626412,66.2049595 C106.172967,63.368876 117.123047,61.9465949 128.00106,61.8978432 C138.879073,61.9465949 149.837632,63.368876 160.067033,66.2049595 C184.49805,49.6441813 195.231926,53.0843636 195.231926,53.0843636 C202.199197,70.715562 197.815773,83.7344152 196.486756,86.9583937 C204.694018,95.9223682 209.660343,107.340889 209.660343,121.315702 C209.660343,170.478725 179.716133,181.303747 151.213281,184.472614 C155.80443,188.444828 159.895342,196.234518 159.895342,208.176593 C159.895342,225.303317 159.746968,239.087361 159.746968,243.303333 C159.746968,246.709601 162.05102,250.70089 168.53925,249.443941 C219.370432,232.499507 256,184.536204 256,128.00106 C256,57.3066942 198.691187,0 128.00106,0 Z M47.9405593,182.340212 C47.6586465,182.976105 46.6581745,183.166873 45.7467277,182.730227 C44.8183235,182.312656 44.2968914,181.445722 44.5978808,180.80771 C44.8734344,180.152739 45.876026,179.97045 46.8023103,180.409216 C47.7328342,180.826786 48.2627451,181.702199 47.9405593,182.340212 Z M54.2367892,187.958254 C53.6263318,188.524199 52.4329723,188.261363 51.6232682,187.366874 C50.7860088,186.474504 50.6291553,185.281144 51.2480912,184.70672 C51.8776254,184.140775 53.0349512,184.405731 53.8743302,185.298101 C54.7115892,186.201069 54.8748019,187.38595 54.2367892,187.958254 Z M58.5562413,195.146347 C57.7719732,195.691096 56.4895886,195.180261 55.6968417,194.042013 C54.9125733,192.903764 54.9125733,191.538713 55.713799,190.991845 C56.5086651,190.444977 57.7719732,190.936735 58.5753181,192.066505 C59.3574669,193.22383 59.3574669,194.58888 58.5562413,195.146347 Z M65.8613592,203.471174 C65.1597571,204.244846 63.6654083,204.03712 62.5716717,202.981538 C61.4524999,201.94927 61.1409122,200.484596 61.8446341,199.710926 C62.5547146,198.935137 64.0575422,199.15346 65.1597571,200.200564 C66.2704506,201.230712 66.6095936,202.705984 65.8613592,203.471174 Z M75.3025151,206.281542 C74.9930474,207.284134 73.553809,207.739857 72.1039724,207.313809 C70.6562556,206.875043 69.7087748,205.700761 70.0012857,204.687571 C70.302275,203.678621 71.7478721,203.20382 73.2083069,203.659543 C74.6539041,204.09619 75.6035048,205.261994 75.3025151,206.281542 Z M86.046947,207.473627 C86.0829806,208.529209 84.8535871,209.404622 83.3316829,209.4237 C81.8013,209.457614 80.563428,208.603398 80.5464708,207.564772 C80.5464708,206.498591 81.7483088,205.631657 83.2786917,205.606221 C84.8005962,205.576546 86.046947,206.424403 86.046947,207.473627 Z M96.6021471,207.069023 C96.7844366,208.099171 95.7267341,209.156872 94.215428,209.438785 C92.7295577,209.710099 91.3539086,209.074206 91.1652603,208.052538 C90.9808515,206.996955 92.0576306,205.939253 93.5413813,205.66582 C95.054807,205.402984 96.4092596,206.021919 96.6021471,207.069023 Z" fill="#161614"/>
</g>
</svg>
Side by side

After

Width:  |  Height:  |  Size: 3.8 KiB

19
.docs/index.html
View file

@ -9,12 +9,13 @@ date: 2000-01-01
<h1>WorldEditAdditions</h1>
<p>
<a href="https://content.minetest.net/packages/Starbeamrainbowlabs/worldeditadditions/"><img src="https://img.shields.io/badge/dynamic/json?color=%23375a7f&amp;label=ContentDB&amp;query=downloads&amp;suffix=+downloads&amp;url=https%3A//content.minetest.net/api/packages/Starbeamrainbowlabs/worldeditadditions/" alt="WorldEditAdditions on ContentDB" /></a>
<a href="https://forum.minetest.net/viewtopic.php?f=11&t=24635"><img src="https://img.shields.io/badge/%F0%9F%92%AC-Forums-%2366D034" alt="WorldEditAdditions on the Minetest Forums" /></a>
<a href="https://github.com/sbrl/Minetest-WorldEditAdditions/releases/latest"><img src="https://img.shields.io/github/v/release/sbrl/Minetest-WorldEditAdditions?color=green&amp;label=latest%20release" alt="Latest release on GitHub" /></a>
<a href="/Changelog"><img src="https://img.shields.io/badge/%F0%9F%93%B0-Changelog-informational" alt="View the changelog" /></a>
</p>
<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>
<p><a href="#get-started" class="bigbutton">Get Started</a></p>
<p><a href="#download" class="bigbutton">Get Started</a></p>
</section>
<section class="features-large">
@ -70,7 +71,7 @@ date: 2000-01-01
</section>
<section>
<h2 class="shadow-text">Download</h2>
<h2 id="download" class="shadow-text">Download</h2>
<div class="features-large">
<div class="features-item wide text-centre">
<h3>ContentDB</h3>
@ -91,3 +92,17 @@ git clone https://github.com/sbrl/Minetest-WorldEditAdditions.git;</code></pre>
</div>
</div>
</section>
<section>
<h2 class="shadow-text">Getting Started</h2>
<div class="panel-generic">
<p>If you're familiar with WorldEdit already, then WorldEditAdditions will follow the existing expectations you're used to. For players new to WorldEdit / WorldEditAdditions, we have a tutorial that will get you up to speed in no time!</p>
<ul class="bigbutton-list">
<li><a class="bigbutton" href="/Reference">Reference</a></li>
<li><a class="bigbutton" href="/Cookbook">Cookbook</a></li>
<li><a class="bigbutton" href="/Tutorial">Tutorial for Beginners</a></li>
</ul>
</div>
</section>