diff --git a/.editorconfig b/.editorconfig index c105aabf5..6cf20e316 100644 --- a/.editorconfig +++ b/.editorconfig @@ -253,7 +253,7 @@ resharper_enforce_while_statement_braces_highlighting=hint [*.{sln,csproj,bat}] end_of_line=crlf -[*.{yml,json,md,sh}] +[*.{yml,json,md,sh,css,html}] end_of_line=lf indent_size=2 tab_width=2 diff --git a/.github/workflows/update-docs.yml b/.github/workflows/update-docs.yml new file mode 100644 index 000000000..455c241e0 --- /dev/null +++ b/.github/workflows/update-docs.yml @@ -0,0 +1,15 @@ +name: ci +on: + push: + branches: + - master +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force diff --git a/CNAME b/CNAME new file mode 100644 index 000000000..9716c910a --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +modernuo.com diff --git a/LICENSE b/LICENSE index ecd241d0e..105ba776b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,3 +1,5 @@ +Copyright 2019-2020 ModernUO Development Team (Kamron Batman) + GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES index b8636df40..66eecff40 100644 --- a/THIRD-PARTY-NOTICES +++ b/THIRD-PARTY-NOTICES @@ -627,3 +627,54 @@ 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. + +Licen notice for mkdocs +--------------------------- +Copyright © 2014, Tom Christie. All rights reserved. + +Redistribution and use in source and binary forms, with or +without modification, are permitted provided that the following +conditions are met: + +Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. +Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in +the documentation and/or other materials provided with the +distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND +CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +License notice for mkdocs-material +--------------------------- +Copyright (c) 2016-2020 Martin Donath + +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 NON-INFRINGEMENT. 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/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css new file mode 100644 index 000000000..e9fd6e018 --- /dev/null +++ b/docs/assets/stylesheets/extra.css @@ -0,0 +1,52 @@ +:root { + --muo-gold: #d5bf74; + --muo-gold-a-link: #947a40; + + /* default */ + --md-default-fg-color: #212121; + --md-default-bg-color: #ffffff; + + /* primary */ + --md-primary-fg-color: #212121; + --md-primary-bg-color: #ffffff; + --md-primary-fg-color--dark: #212121; + + /* accent */ + --md-accent-fg-color: var(--muo-gold); +} + +:root > * { + --md-code-bg-color: #6d6d6d; + --md-code-fg-color: #ffffff; + + --md-typeset-a-color: var(--muo-gold-a-link); + + --md-footer-fg-color: #ffffff; + --md-footer-bg-color: #212121; + --md-footer-bg-color--dark: #212121; +} + +.md-tabs__link--active, +.md-tabs__link:focus, +.md-tabs__link:hover, +.md-footer-nav__link:focus, +.md-footer-nav__link:hover, +.md-header-nav__button:focus, +.md-header-nav__button:hover, +.md-source:hover, +html .md-footer-meta.md-typeset a:focus, +html .md-footer-meta.md-typeset a:hover { + color: var(--muo-gold); + opacity: 1; +} + +@media screen and (max-width: 76.1875em) { + .md-nav--primary .md-nav__title[for=__drawer] .md-nav__button { + left: 3.75rem; + } + + .md-nav--primary .md-nav__title { + padding: 3rem 3.75rem 0.2rem + } +} + diff --git a/docs/branding/android-chrome-192x192.png b/docs/branding/android-chrome-192x192.png new file mode 100644 index 000000000..177604a9e Binary files /dev/null and b/docs/branding/android-chrome-192x192.png differ diff --git a/docs/branding/android-chrome-512x512.png b/docs/branding/android-chrome-512x512.png new file mode 100644 index 000000000..0fda32a43 Binary files /dev/null and b/docs/branding/android-chrome-512x512.png differ diff --git a/docs/branding/apple-touch-icon.png b/docs/branding/apple-touch-icon.png new file mode 100644 index 000000000..c6ce40fcd Binary files /dev/null and b/docs/branding/apple-touch-icon.png differ diff --git a/docs/branding/favicon-16x16.png b/docs/branding/favicon-16x16.png new file mode 100644 index 000000000..45b6741aa Binary files /dev/null and b/docs/branding/favicon-16x16.png differ diff --git a/docs/branding/favicon-32x32.png b/docs/branding/favicon-32x32.png new file mode 100644 index 000000000..023b48d9a Binary files /dev/null and b/docs/branding/favicon-32x32.png differ diff --git a/docs/branding/favicon.ico b/docs/branding/favicon.ico new file mode 100644 index 000000000..10c47ee1c Binary files /dev/null and b/docs/branding/favicon.ico differ diff --git a/docs/branding/favicon.png b/docs/branding/favicon.png new file mode 100644 index 000000000..023b48d9a Binary files /dev/null and b/docs/branding/favicon.png differ diff --git a/docs/branding/logo.svg b/docs/branding/logo.svg new file mode 100644 index 000000000..5583999ad --- /dev/null +++ b/docs/branding/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/branding/mstile-144x144.png b/docs/branding/mstile-144x144.png new file mode 100644 index 000000000..a03597d2e Binary files /dev/null and b/docs/branding/mstile-144x144.png differ diff --git a/docs/branding/mstile-150x150.png b/docs/branding/mstile-150x150.png new file mode 100644 index 000000000..f5ccc900e Binary files /dev/null and b/docs/branding/mstile-150x150.png differ diff --git a/docs/branding/mstile-310x150.png b/docs/branding/mstile-310x150.png new file mode 100644 index 000000000..6196557f9 Binary files /dev/null and b/docs/branding/mstile-310x150.png differ diff --git a/docs/branding/mstile-310x310.png b/docs/branding/mstile-310x310.png new file mode 100644 index 000000000..fcab2046c Binary files /dev/null and b/docs/branding/mstile-310x310.png differ diff --git a/docs/branding/mstile-70x70.png b/docs/branding/mstile-70x70.png new file mode 100644 index 000000000..2416cf18d Binary files /dev/null and b/docs/branding/mstile-70x70.png differ diff --git a/docs/branding/safari-pinned-tab.svg b/docs/branding/safari-pinned-tab.svg new file mode 100644 index 000000000..55d1c1fc7 --- /dev/null +++ b/docs/branding/safari-pinned-tab.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/branding/uologo-black-flat.svg b/docs/branding/uologo-black-flat.svg new file mode 100644 index 000000000..0694c6d69 --- /dev/null +++ b/docs/branding/uologo-black-flat.svg @@ -0,0 +1 @@ + diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 000000000..81e62a376 --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,7 @@ +--- +title: Get Started +--- + +# Getting Started + +Coming soon... diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..e4484eb48 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,4 @@ +--- +title: ModernUO +template: home.html +--- diff --git a/docs/overrides/.icons/modernuo/logo.svg b/docs/overrides/.icons/modernuo/logo.svg new file mode 100644 index 000000000..5583999ad --- /dev/null +++ b/docs/overrides/.icons/modernuo/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/overrides/home.html b/docs/overrides/home.html new file mode 100644 index 000000000..406173eb7 --- /dev/null +++ b/docs/overrides/home.html @@ -0,0 +1,152 @@ +{% extends "main.html" %} + + +{% block tabs %} +{{ super() }} + + + + +
+
+
+
+ +
+ + +
+

Ultima Online Server Emulator for the modern era!

+ + Get started + + + Go to GitHub + +
+
+
+
+{% endblock %} + + +{% block content %}{% endblock %} + + +{% block footer %} +{% include "partials/footer.html" %} +{% endblock %} diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 000000000..acd328ae9 --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,48 @@ +{% extends "base.html" %} + + +{% block extrahead %} + + +{% set title = config.site_name %} +{% if page and page.title and not page.is_homepage %} +{% set title = config.site_name ~ " - " ~ page.title | striptags %} +{% endif %} + + +{% set image = config.site_url ~ 'assets/images/logo.svg' %} + + + + + + + + + + + + + + + + + + + + + +{% endblock %} + + +{% block content %} +{{ super() }} + + +
+ +
+{% endblock %} diff --git a/docs/overrides/partials/footer.html b/docs/overrides/partials/footer.html new file mode 100644 index 000000000..b28b2a89e --- /dev/null +++ b/docs/overrides/partials/footer.html @@ -0,0 +1,97 @@ + + +{% import "partials/language.html" as lang with context %} + + + diff --git a/docs/overrides/partials/header.html b/docs/overrides/partials/header.html new file mode 100644 index 000000000..7537eecf2 --- /dev/null +++ b/docs/overrides/partials/header.html @@ -0,0 +1,83 @@ + + + +
+ + + +
diff --git a/docs/overrides/partials/nav.html b/docs/overrides/partials/nav.html new file mode 100644 index 000000000..c3a8bc1ce --- /dev/null +++ b/docs/overrides/partials/nav.html @@ -0,0 +1,69 @@ + + + + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..d484ca15d --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,64 @@ + +# Project +site_name: ModernUO +site_author: Kamron Batman +site_url: https://modernuo.com + +# Repository +repo_name: modernuo/modernuo +repo_url: https://github.com/modernuo/modernuo +site_description: The Ultima Online Server Emulator for the modern era! +copyright: Copyright 2019-2020 ModernUO Development Team +theme: + name: material + favicon: branding/favicon.png + icon: + logo: modernuo/logo + custom_dir: docs/overrides + features: + - tabs + - instant +extra_css: + - assets/stylesheets/extra.css +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/modernuo/modernuo + name: ModernUO on Github + - icon: fontawesome/brands/discord + link: https://discord.gg/DHkNUsq + name: ModernUO on Discord + - icon: fontawesome/brands/patreon + link: https://patreon.com/modernuo + name: Sponsor ModernUO on Patreon + - icon: fontawesome/brands/reddit + link: https://reddit.com/r/modernuo + name: /r/modernuo + - icon: fontawesome/brands/twitter + link: https://twitter.com/modernuo + name: "@modernuo" +markdown_extensions: + - footnotes + - meta + - markdown.extensions.toc: + permalink: true + - attr_list + - pymdownx.inlinehilite + - pymdownx.superfences + - pymdownx.snippets + - pymdownx.tabbed + - pymdownx.tilde + - pymdownx.betterem: + smart_enable: all + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + options: + custom_icons: + - overrides/.icons + +# Pages +nav: + - Home: 'index.md' + - Get Started: + - Installation: getting-started.md