From b4cad61e36902da9a595b00fb074e1382b015d65 Mon Sep 17 00:00:00 2001 From: Kamron Batman <3953314+kamronbatman@users.noreply.github.com> Date: Mon, 14 Sep 2020 00:40:19 -0700 Subject: [PATCH] Adds getting started to docs (#249) - [X] Adds getting started to docs Updates documentation --- docs/assets/stylesheets/extra.css | 19 +++++++++++ docs/building-server.md | 29 ++++++++++++++++ docs/getting-started.md | 7 ---- docs/installation.md | 45 +++++++++++++++++++++++++ docs/overrides/.icons/brands/debian.svg | 3 ++ mkdocs.yml | 9 +++-- 6 files changed, 102 insertions(+), 10 deletions(-) create mode 100644 docs/building-server.md delete mode 100644 docs/getting-started.md create mode 100644 docs/installation.md create mode 100644 docs/overrides/.icons/brands/debian.svg diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css index e9fd6e018..8a8d72c28 100644 --- a/docs/assets/stylesheets/extra.css +++ b/docs/assets/stylesheets/extra.css @@ -50,3 +50,22 @@ html .md-footer-meta.md-typeset a:hover { } } +.windows { + color: #00adef; +} + +.apple { + color: #000000; +} + +.ubuntu { + color: #e95420; +} + +.debian { + color: #d70a53; +} + +.centos { + color: #212078; +} diff --git a/docs/building-server.md b/docs/building-server.md new file mode 100644 index 000000000..b30dc93ea --- /dev/null +++ b/docs/building-server.md @@ -0,0 +1,29 @@ +# Building the Server + +## Compiling + +=== "Windows" + ```bash + ./publish.cmd + ``` + +=== "OSX/Linux" + ```bash + ./publish.sh + ``` +

+`os` (_Optional_)
+The operating system to build the server against. If not specified then the server will be built for the same operating system. + +:fontawesome-brands-windows:{: .windows } `win`
+:fontawesome-brands-apple:{: .apple } `osx`
+:fontawesome-brands-ubuntu:{: .ubuntu } `ubuntu.16.04`, `ubuntu.18.04` `ubuntu.20.04`
+:brands-debian:{: .debian } `debian.9`, `debian.10`
+:fontawesome-brands-centos:{: .centos } `centos.7`, `centos.8`
+ +
+`framework` (_Optional_)
+The framework used to build the server. That framework must be installed. + +.NET Core 3.1 `core`
+.NET 5 Preview `net` diff --git a/docs/getting-started.md b/docs/getting-started.md deleted file mode 100644 index 81e62a376..000000000 --- a/docs/getting-started.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Get Started ---- - -# Getting Started - -Coming soon... diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 000000000..9ca7928e5 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,45 @@ +--- +title: Installation +--- + +# Installation + +## Prerequisites + +=== "Windows" + 1. Download and install git from [here](https://git-scm.com/download/win) + 2. Download and install the latest [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core/3.1) + +=== "OSX" + 1. Install homebrew from [here](https://brew.sh) + 2. Run: + ```bash + brew install git + ``` + 3. Download and install the latest [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core/3.1) + +=== "Linux" + 1. Run: + ```bash + sudo apt update && sudo apt install git + ``` + 2. Download and install the latest [.NET Core SDK](instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/linux)) + +## Clone the Repository + +=== "Windows" + Navigate to the folder where you want to install ModernUO. + +=== "OSX" + Using _terminal_, navigate to the folder where you want to install ModernUO. + +=== "Linux" + Using _bash_, navigate to the folder where you want to install ModernUO. + +Run: +```bash +git clone https://github.com/modernuo/modernuo +``` + +!!! Tip + Operating System: :fontawesome-brands-windows:{: .windows }
    Use _git bash_ as your command prompt diff --git a/docs/overrides/.icons/brands/debian.svg b/docs/overrides/.icons/brands/debian.svg new file mode 100644 index 000000000..c249a7a2d --- /dev/null +++ b/docs/overrides/.icons/brands/debian.svg @@ -0,0 +1,3 @@ + + + diff --git a/mkdocs.yml b/mkdocs.yml index d484ca15d..b24d8ccf6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,7 +14,7 @@ theme: favicon: branding/favicon.png icon: logo: modernuo/logo - custom_dir: docs/overrides + custom_dir: docs/overrides/ features: - tabs - instant @@ -38,11 +38,13 @@ extra: link: https://twitter.com/modernuo name: "@modernuo" markdown_extensions: + - admonition - footnotes - meta - markdown.extensions.toc: permalink: true - attr_list + - pymdownx.highlight - pymdownx.inlinehilite - pymdownx.superfences - pymdownx.snippets @@ -55,10 +57,11 @@ markdown_extensions: emoji_generator: !!python/name:materialx.emoji.to_svg options: custom_icons: - - overrides/.icons + - docs/overrides/.icons # Pages nav: - Home: 'index.md' - Get Started: - - Installation: getting-started.md + - Installation: installation.md + - Building the Server: building-server.md