From bbc24e5b02634ba4c16982da4d7c674f6f91a19c Mon Sep 17 00:00:00 2001 From: 0xnim <0xnim@users.noreply.github.com> Date: Thu, 7 Nov 2024 19:48:40 -0500 Subject: [PATCH 1/9] base is determined in build not in config --- astro.config.mjs | 2 -- 1 file changed, 2 deletions(-) diff --git a/astro.config.mjs b/astro.config.mjs index 35596c8..164e4db 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -4,8 +4,6 @@ import starlight from '@astrojs/starlight'; // https://astro.build/config export default defineConfig({ - site: 'https://ferrumc-rs.github.io/', - base: 'docs', integrations: [ starlight({ title: 'FerrumC Docs', From 6a3918e6fb790325306ea6fed0bc4d7dfa8fe1da Mon Sep 17 00:00:00 2001 From: 0xnim <0xnim@users.noreply.github.com> Date: Thu, 7 Nov 2024 19:56:38 -0500 Subject: [PATCH 2/9] Some updates to frontpage, better stuff is coming later --- src/content/docs/index.mdx | 6 +++++- src/content/docs/start/getting_started.mdx | 2 ++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index d0a135c..816b714 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -1,7 +1,11 @@ --- title: FerrumC description: Get started building your docs site with Starlight. -template: splash +template: doc +tableOfContents: false +banner: + content: | + We are still in alpha development! hero: tagline: A lightweight 1.21 Minecraft server implementation in Rust. image: diff --git a/src/content/docs/start/getting_started.mdx b/src/content/docs/start/getting_started.mdx index e8483d2..81b8608 100644 --- a/src/content/docs/start/getting_started.mdx +++ b/src/content/docs/start/getting_started.mdx @@ -1,6 +1,8 @@ --- title: 🚀 Getting Started description: Quickly get up and running with FerrumC. + +perv: false --- import { Aside, Badge, FileTree, Tabs, TabItem, Steps } from '@astrojs/starlight/components'; From 69e3ae9b9ed43324e8b187bfc19b10970c8df637 Mon Sep 17 00:00:00 2001 From: 0xnim <0xnim@users.noreply.github.com> Date: Thu, 7 Nov 2024 20:42:09 -0500 Subject: [PATCH 3/9] Small fixes --- src/content/docs/about/faq.md | 2 +- src/content/docs/index.mdx | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/content/docs/about/faq.md b/src/content/docs/about/faq.md index 41e3f52..835ca96 100644 --- a/src/content/docs/about/faq.md +++ b/src/content/docs/about/faq.md @@ -7,7 +7,7 @@ description: Frequently asked questions about FerrumC. Yes! It is not currently on our list of priorities, and it is very unlikely that we will be able to mirror Vanilla world generation 1:1. However, we do plan on implementing some form of terrain generation as soon as we can. ## What does 'FerrumC' mean? -It's a play on words. Ferrum is the Lain word for iron and it ***rusts***. And MC (Minecraft) is in the end. So it becomes Ferru*mc*. Get it? +It's a play on words. Ferrum is the Latin word for iron and it ***rusts***. And MC (Minecraft) is in the end. So it becomes Ferru*mc*. Get it? ## How does this project differ from: 1. **[Valence](https://valence.rs/)**:\ diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 816b714..fc145b2 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -3,6 +3,8 @@ title: FerrumC description: Get started building your docs site with Starlight. template: doc tableOfContents: false +next: false +prev: false banner: content: | We are still in alpha development! From c8dc09f66d82b819906c53410c523691aaab1826 Mon Sep 17 00:00:00 2001 From: 0xnim <0xnim@users.noreply.github.com> Date: Fri, 8 Nov 2024 07:16:41 -0500 Subject: [PATCH 4/9] Insane feature --- src/components/HeadlessTabs.astro | 16 ++++++++++++++++ src/content/docs/start/getting_started.mdx | 5 +++-- 2 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 src/components/HeadlessTabs.astro diff --git a/src/components/HeadlessTabs.astro b/src/components/HeadlessTabs.astro new file mode 100644 index 0000000..b402065 --- /dev/null +++ b/src/components/HeadlessTabs.astro @@ -0,0 +1,16 @@ +--- +import { Tabs } from '@astrojs/starlight/components'; +import type { ComponentProps } from 'astro/types'; + +type Props = ComponentProps; +--- + +
+ +
+ + \ No newline at end of file diff --git a/src/content/docs/start/getting_started.mdx b/src/content/docs/start/getting_started.mdx index 81b8608..3de3ba0 100644 --- a/src/content/docs/start/getting_started.mdx +++ b/src/content/docs/start/getting_started.mdx @@ -6,6 +6,7 @@ perv: false --- import { Aside, Badge, FileTree, Tabs, TabItem, Steps } from '@astrojs/starlight/components'; +import HeadlessTabs from '~/components/HeadlessTabs.astro'; ## Prerequisites @@ -193,7 +194,7 @@ This will create a `ferrumc` executable in the `target/release` directory. ### Run - + ~~~bash ./ferrumc @@ -209,7 +210,7 @@ This will create a `ferrumc` executable in the `target/release` directory. .\ferrumc.exe ~~~ - + You can change logging level by using ```--log=```: ~~~bash From 2bf6b35a1deb002dfc8f8067492b49fac0f6184c Mon Sep 17 00:00:00 2001 From: 0xnim <0xnim@users.noreply.github.com> Date: Fri, 8 Nov 2024 16:50:28 -0500 Subject: [PATCH 5/9] Insane upgrade --- src/content/docs/start/getting_started.mdx | 118 +++++++++++++++++---- 1 file changed, 96 insertions(+), 22 deletions(-) diff --git a/src/content/docs/start/getting_started.mdx b/src/content/docs/start/getting_started.mdx index 3de3ba0..ccff697 100644 --- a/src/content/docs/start/getting_started.mdx +++ b/src/content/docs/start/getting_started.mdx @@ -163,30 +163,90 @@ This will create a `ferrumc` executable in the `target/release` directory. 2. Select the **latest** successful workflow 2. **Generate a config file** - ~~~bash - ./ferrumc --setup - ~~~ + + + ~~~bash + ./ferrumc --setup + ~~~ + + + ~~~bash + ./ferrumc --setup + ~~~ + + + ~~~powershell + .\ferrumc.exe --setup + ~~~ + + 3. **Import an existing world** Place the region files (.mca) in the folder named import then run - ~~~bash - ./ferrumc --import - ~~~ + + + ~~~bash + ./ferrumc --import + ~~~ + + + ~~~bash + ./ferrumc --import + ~~~ + + + ~~~powershell + .\ferrumc.exe --import + ~~~ + + The location of these files in minecraft is explained [here](https://minecraft.wiki/w/Region_file_format#Location) - - - - import region files in here - - ... - - config.toml - - ferrumc - - + + + + - import region files in here + - ... + - config.toml + - ferrumc + + + + + - import region files in here + - ... + - config.toml + - ferrumc + + + + + - import region files in here + - ... + - config.toml + - ferrumc.exe + + + @@ -206,16 +266,30 @@ This will create a `ferrumc` executable in the `target/release` directory. ~~~ - ~~~bash + ~~~cmd .\ferrumc.exe ~~~ You can change logging level by using ```--log=```: -~~~bash -./ferrumc --log=info #for info level logging -~~~ + + + ~~~bash + ./ferrumc --log=info #for info level logging + ~~~ + + + ~~~bash + ./ferrumc --log=info #for info level logging + ~~~ + + + ~~~cmd + .\ferrumc.exe --log=info #for info level logging + ~~~ + + ###### Logging values: - trace (Extremely verbose) @@ -232,7 +306,7 @@ You can change logging level by using ```--log=```: export FERRUMC_ROOT=/home/YourUser/Documents/Code/Rust/ferrumc ~~~ - + ~~~bash export FERRUMC_ROOT=/home/YourUser/Documents/Code/Rust/ferrumc ~~~ From 94f9d0fd0e9b810df147585f0ba273b83c527f95 Mon Sep 17 00:00:00 2001 From: 0xnim <0xnim@users.noreply.github.com> Date: Fri, 8 Nov 2024 16:57:53 -0500 Subject: [PATCH 6/9] lil update --- src/content/docs/start/getting_started.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/start/getting_started.mdx b/src/content/docs/start/getting_started.mdx index ccff697..9a7a399 100644 --- a/src/content/docs/start/getting_started.mdx +++ b/src/content/docs/start/getting_started.mdx @@ -156,7 +156,7 @@ Before starting, make sure you have the following prerequisites: This will create a `ferrumc` executable in the `target/release` directory. -### Pre-Run +## Pre-Run 1. **Move the FerrumC binary to your desired server directory** @@ -252,7 +252,7 @@ This will create a `ferrumc` executable in the `target/release` directory. -### Run +## Run From 064342055986da09d9cb1b38bdcd1dbf79468372 Mon Sep 17 00:00:00 2001 From: 0xnim <0xnim@users.noreply.github.com> Date: Fri, 8 Nov 2024 18:56:18 -0500 Subject: [PATCH 7/9] Theme --- astro.config.mjs | 3 +++ src/style/theme.css | 29 +++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 src/style/theme.css diff --git a/astro.config.mjs b/astro.config.mjs index 164e4db..c36c06c 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -29,6 +29,9 @@ export default defineConfig({ }, ], favicon: "/favicon.ico", + customCss: [ + 'src/style/theme.css', + ], }), ], }); diff --git a/src/style/theme.css b/src/style/theme.css new file mode 100644 index 0000000..b74fb45 --- /dev/null +++ b/src/style/theme.css @@ -0,0 +1,29 @@ +/* Dark mode colors. */ +:root { + --sl-color-accent-low: #460b05; + --sl-color-accent: #c60e00; + --sl-color-accent-high: #feb3a6; + --sl-color-white: #ffffff; + --sl-color-gray-1: #f3ecea; + --sl-color-gray-2: #c8c0be; + --sl-color-gray-3: #978784; + --sl-color-gray-4: #635451; + --sl-color-gray-5: #423432; + --sl-color-gray-6: #302321; + --sl-color-black: #1d1715; +} +/* Light mode colors. */ +:root[data-theme='light'] { + --sl-color-accent-low: #ffc8be; + --sl-color-accent: #c90e00; + --sl-color-accent-high: #640300; + --sl-color-white: #1d1715; + --sl-color-gray-1: #302321; + --sl-color-gray-2: #423432; + --sl-color-gray-3: #635451; + --sl-color-gray-4: #978784; + --sl-color-gray-5: #c8c0be; + --sl-color-gray-6: #f3ecea; + --sl-color-gray-7: #f9f5f5; + --sl-color-black: #ffffff; +} \ No newline at end of file From 78b6961443cc2f34df7fbbd65e818602339a6848 Mon Sep 17 00:00:00 2001 From: Niklas Wojtkowiak <57798165+0xnim@users.noreply.github.com> Date: Sat, 9 Nov 2024 14:27:57 -0500 Subject: [PATCH 8/9] please be fine --- LICENSE | 21 --------------------- README.md | 18 +----------------- src/components/HeadlessTabs.astro | 3 +++ src/content/docs/start/getting_started.mdx | 2 +- src/style/theme.css | 2 +- 5 files changed, 6 insertions(+), 40 deletions(-) delete mode 100644 LICENSE diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 21b2d7d..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2024 FerrumC - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md index 081ca39..95030ad 100644 --- a/README.md +++ b/README.md @@ -1,17 +1 @@ -# FerrumC Documentation -This is the public repository for our documentation.\ -You can access the docs [here](https://docs.ferrumc.com/). - -## Contributing -Want to contribute? See the below guide. - -1. [Fork the repository](https://github.com/ferrumc-rs/docs/fork) and then clone it. -```bash -git clone https://github.com/user/docs -``` - -2. Open a terminal in the new cloned repository folder and run `npm install`. This will install necessary dependencies. - -3. Run `npm run dev` to start a dev server. You will be provided with a link that will update automatically on changes. - -4. Make your changes! Experiment, and then open a PR. \ No newline at end of file +## This work is licensed under a CC BY 4.0 licence. \ No newline at end of file diff --git a/src/components/HeadlessTabs.astro b/src/components/HeadlessTabs.astro index 97ccadc..b402065 100644 --- a/src/components/HeadlessTabs.astro +++ b/src/components/HeadlessTabs.astro @@ -1,11 +1,14 @@ --- import { Tabs } from '@astrojs/starlight/components'; import type { ComponentProps } from 'astro/types'; + type Props = ComponentProps; --- +
+