From 24c683870d24ddf50dd23041c1f1b68af2f9c181 Mon Sep 17 00:00:00 2001
From: Kamron Batman <3953314+kamronbatman@users.noreply.github.com>
Date: Mon, 3 Jan 2022 22:10:29 -0800
Subject: [PATCH] docs: Updates markdown docs (#912)
---
docs/assets/stylesheets/extra.css | 10 +++++++++-
docs/building-server.md | 5 +++--
docs/installation.md | 12 +++++------
docs/quick-start.md | 33 -------------------------------
mkdocs.yml | 7 ++++---
5 files changed, 22 insertions(+), 45 deletions(-)
delete mode 100644 docs/quick-start.md
diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css
index 73389904f..dfe2e4d38 100644
--- a/docs/assets/stylesheets/extra.css
+++ b/docs/assets/stylesheets/extra.css
@@ -83,17 +83,25 @@ html .md-footer-meta.md-typeset a:hover {
}
.linuxmint {
- color: #87CF3E;
+ color: #87cF3e;
}
.debian {
color: #d70a53;
}
+.fedora {
+ color: #3c6eb4;
+}
+
.centos {
color: #212078;
}
+.redhat {
+ color: #be0000;
+}
+
.codehilitetable .linenodiv pre, .highlighttable .linenodiv pre {
color: var(--md-default-bg-color);
}
diff --git a/docs/building-server.md b/docs/building-server.md
index 232f1f930..9e2e63b71 100644
--- a/docs/building-server.md
+++ b/docs/building-server.md
@@ -24,7 +24,8 @@ The operating system to build the server against. If not specified then the serv
:fontawesome-brands-windows:{: .windows } `win`
:fontawesome-brands-apple:{: .apple } `osx`
:fontawesome-brands-ubuntu:{: .ubuntu } `ubuntu.14.04` `ubuntu.16.04`, `ubuntu.18.04` `ubuntu.20.04`
-:brands-linuxmint:{: .linuxmint } `linuxmint.17` `linuxmint.18`, `linuxmint.19`
+:brands-linuxmint:{: .linuxmint } `linuxmint.17` `linuxmint.18`, `linuxmint.19`, `ubuntu.20.04` for v20
:brands-debian:{: .debian } `debian.9`, `debian.10`
-:fontawesome-brands-centos:{: .centos } `centos.7`, `centos.8`
+:fontawesome-brands-fedora:{: .fedora } `fedora.32`, `fedora.33`, `fedora.34`
+:fontawesome-brands-centos:{: .centos } `centos.7`, `centos.8`
:fontawesome-brands-redhat:{: .redhat } `redhat.7`, `redhat.8`
diff --git a/docs/installation.md b/docs/installation.md
index 6fcb6d794..edf4c673b 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -21,14 +21,14 @@ title: Installation
```
=== "OSX"
- Prerequisites
- 1. Download and install the latest [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0)
+ ### Prerequisites
+ 1. Download and install the latest [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0).
1. Using _terminal_, install [homebrew](https://brew.sh) and git:
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
brew install git
```
- Install ModernUO
+ ### Install ModernUO
1. Using _terminal_, navigate to the folder where you want to install ModernUO and run:
```bash
git clone https://github.com/modernuo/modernuo
@@ -36,8 +36,8 @@ title: Installation
```
=== "Linux"
- Prerequisites
- 1. Download and install the latest [.NET 6 SDK](instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/linux))
+ ### Prerequisites
+ 1. Download and install the latest [.NET 6 SDK](https://docs.microsoft.com/en-us/dotnet/core/install/linux).
1. Using _bash_, install git:
```bash
sudo apt update && sudo apt install git
@@ -46,7 +46,7 @@ title: Installation
!!! Note
The command to install git might be different for your flavor of linux. Consult your local Google search for answers.
- Install ModernUO
+ ### Install ModernUO
1. Using _bash_, navigate to the folder where you want to install ModernUO and run:
```bash
git clone https://github.com/modernuo/modernuo
diff --git a/docs/quick-start.md b/docs/quick-start.md
deleted file mode 100644
index bd14b4f75..000000000
--- a/docs/quick-start.md
+++ /dev/null
@@ -1,33 +0,0 @@
----
-title: Quick Start
----
-
-# Quick Start
-
-If you are familiar with RunUO, then follow these steps to get your ModernUO server running in less than 10 minutes:
-
-=== "Windows"
- 1. Download and install the [.NET 6 Runtime](https://dotnet.microsoft.com/download/dotnet/6.0)
- 1. Using [git](https://git-scm.com/downloads), clone the ModernUO repository to a folder.
- 1. Run publish.cmd
- 1. Navigate to the _Distribution_ folder.
- 1. Run `ModernUO.exe`
-
-=== "OSX"
- 1. Download and install the [.NET 6 Runtime](https://dotnet.microsoft.com/download/dotnet/6.0)
- 1. Using [git](https://git-scm.com/downloads), clone the ModernUO repository to a folder.
- 1. Using _terminal_, navigate to the _ModernUO_ folder.
- 1. Run `./publish.cmd`
- 1. Using _terminal_, navigate to the _Distribution_ folder.
- 1. Run `dotnet ModernUO.dll`
-
-=== "Linux"
- 1. Download and install the [.NET 6 Runtime](https://docs.microsoft.com/en-us/dotnet/core/install/linux)
- 1. Using [git](https://git-scm.com/downloads), clone the ModernUO repository to a folder.
- 1. Using _bash_, navigate to the _ModernUO_ folder.
- 1. Run `./publish.cmd`
- 1. Using _bash_, navigate to the _Distribution_ folder.
- 1. Run `dotnet ModernUO.dll`
-
-!!! Note
- Follow the rest of the [Get Started](../installation) guide to learn how to connect, configure, and customize, your server.
diff --git a/mkdocs.yml b/mkdocs.yml
index d0dbbf9f4..58cee9c59 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -41,14 +41,16 @@ markdown_extensions:
- admonition
- footnotes
- meta
- - markdown.extensions.toc:
+ - toc:
+ toc_depth: "1-1"
permalink: true
- attr_list
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.snippets
- - pymdownx.tabbed
+ - pymdownx.tabbed:
+ alternate_style: true
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
@@ -67,6 +69,5 @@ markdown_extensions:
nav:
- Home: 'index.md'
- 'Get Started':
- - 'quick-start.md'
- 'installation.md'
- 'building-server.md'