Adds ModernUO docs skeleton (#243)

This commit is contained in:
Kamron Batman 2020-09-13 15:21:28 -07:00 committed by GitHub
parent 16bdc21f5a
commit 8f378dbd78
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 650 additions and 1 deletions

View file

@ -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

15
.github/workflows/update-docs.yml vendored Normal file
View file

@ -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

1
CNAME Normal file
View file

@ -0,0 +1 @@
modernuo.com

View file

@ -1,3 +1,5 @@
Copyright 2019-2020 ModernUO Development Team (Kamron Batman) <hi@modernuo.com>
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

View file

@ -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 <martin.donath@squidfunk.com>
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.

View file

@ -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
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.6 KiB

BIN
docs/branding/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

BIN
docs/branding/favicon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.6 KiB

1
docs/branding/logo.svg Normal file
View file

@ -0,0 +1 @@
<svg height="529.15997" viewBox="0 0 529.15997 529.15997" width="529.15997" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><clipPath id="a"><path d="m2512.85 434.602c664.19 226.828 1108.92 846.878 1108.92 1549.778 0 506.38-229.59 976.52-629.89 1289.87l-48.49 37.96v-1419.24c0-285.63-16.44-484.51-48.85-591.12-31.25-102.71-92.53-204.08-182.15-301.28-59.65-64.691-126.61-118.961-199.54-161.781v2695.511l-20.68 6.77c-163.79 53.55-334.64 80.71-507.81 80.71-116.47 0-232.75-12.43-346.2-36.98v323.08c114.09 20.48 230.43 30.86 346.2 30.86 1077.66 0 1954.37-876.72 1954.37-1954.36 0-877.2-584.34-1645.45-1425.88-1881.771z"/></clipPath><linearGradient id="b" gradientTransform="matrix(0 -3981.4 -3981.4 0 2788.45 3927.9)" gradientUnits="userSpaceOnUse" spreadMethod="pad" x1="0" x2="1" y1="0" y2="0"><stop offset="0" stop-color="#bfbdbb"/><stop offset=".248485" stop-color="#fbfcfc"/><stop offset=".484848" stop-color="#959696"/><stop offset=".70303" stop-color="#f0f0f0"/><stop offset="1" stop-color="#8d8d8d"/></linearGradient><clipPath id="c"><path d="m1984.36 30.0117c-1077.637 0-1954.36 876.7073-1954.36 1954.3683 0 877.19 584.355 1645.42 1425.89 1881.75v-2120.73c0-174.88 16.68-297.63 50.98-375.3 36.14-81.88 96.23-147.98 178.61-196.45 80.54-47.37 177.6-71.39 288.48-71.39 116.83 0 219.8 26.54 306.04 78.89 12.05 7.32 23.7 15.02 34.9 23.06v-449.19c-98.23-27.68-208.6-41.7-328.46-41.7-206.52 0-387.97 45.481-539.3 135.2-150.47 89.179-259.14 201.46-323.02 333.71-65.54 135.72-98.77 374.85-98.77 710.74v1419.24l-48.491-37.96c-400.308-313.35-629.89-783.49-629.89-1289.87 0-902.87 734.531-1637.411 1637.391-1637.411 111.23 0 222.24 11.269 330.54 33.543v-322.4534c-108.89-18.6289-219.96-28.0469-330.54-28.0469z"/></clipPath><linearGradient id="d" gradientTransform="matrix(0 -3981.4 -3981.4 0 1172.45 3927.91)" gradientUnits="userSpaceOnUse" spreadMethod="pad" x1="0" x2="1" y1="0" y2="0"><stop offset="0" stop-color="#ae9964"/><stop offset=".248485" stop-color="#fbe383"/><stop offset=".484848" stop-color="#8d7036"/><stop offset=".714286" stop-color="#c9b14e"/><stop offset="1" stop-color="#7f6740"/></linearGradient><g transform="matrix(.13333333 0 0 -.13333333 0 529.16)"><path d="m1984.36 3968.74c-128.6 0-254.34-12.45-376.2-35.93v-385.64c120.72 29.1 246.68 44.61 376.2 44.61 173.94 0 341.47-27.89 498.49-79.23v-2724.37c92.71 47.199 177.2 111.371 251.6 192.058 92.7 100.542 156.23 205.822 188.8 312.892 33.27 109.43 50.14 311.26 50.14 599.84v1357.66c376.17-294.47 618.38-752.6 618.38-1266.25 0-712.39-465.88-1317.919-1108.92-1528.189v-392.7613c853.7 221.6793 1485.88 998.8603 1485.88 1920.9503 0 1094.17-890.17 1984.36-1984.37 1984.36" fill="#dfdfdd"/><g clip-path="url(#a)"><path d="m2512.85 434.602c664.19 226.828 1108.92 846.878 1108.92 1549.778 0 506.38-229.59 976.52-629.89 1289.87l-48.49 37.96v-1419.24c0-285.63-16.44-484.51-48.85-591.12-31.25-102.71-92.53-204.08-182.15-301.28-59.65-64.691-126.61-118.961-199.54-161.781v2695.511l-20.68 6.77c-163.79 53.55-334.64 80.71-507.81 80.71-116.47 0-232.75-12.43-346.2-36.98v323.08c114.09 20.48 230.43 30.86 346.2 30.86 1077.66 0 1954.37-876.72 1954.37-1954.36 0-877.2-584.34-1645.45-1425.88-1881.771v331.993" fill="url(#b)"/></g><path d="m1973.96 1132.26c-105.46 0-197.39 22.62-273.26 67.24-76.85 45.22-132.83 106.7-166.38 182.71-32.59 73.78-48.43 192.58-48.43 363.19v1226.51 540.64 392.76c-853.699-221.68-1485.89-998.85-1485.89-1920.93 0-1094.2 890.184-1984.3682812 1984.36-1984.3682812 123.1 0 243.58 11.3476812 360.54 32.9179812v384.8203c-115.94-26.668-236.61-40.781-360.54-40.781-886.32 0-1607.391 721.081-1607.391 1607.411 0 513.65 242.207 971.78 618.383 1266.25v-1357.66c0-340.44 34.228-583.96 101.758-723.78 66.48-137.66 179.09-254.221 334.73-346.471 156.02-92.489 342.61-139.387 554.6-139.387 132.62 0 252.67 16.719 358.46 49.25v535.068c-23.54-22.21-50.33-42.57-80.46-60.85-81.5-49.46-179.23-74.54-290.48-74.54" fill="#e9cf72"/><g clip-path="url(#c)"><path d="m1984.36 30.0117c-1077.637 0-1954.36 876.7073-1954.36 1954.3683 0 877.19 584.355 1645.42 1425.89 1881.75v-2120.73c0-174.88 16.68-297.63 50.98-375.3 36.14-81.88 96.23-147.98 178.61-196.45 80.54-47.37 177.6-71.39 288.48-71.39 116.83 0 219.8 26.54 306.04 78.89 12.05 7.32 23.7 15.02 34.9 23.06v-449.19c-98.23-27.68-208.6-41.7-328.46-41.7-206.52 0-387.97 45.481-539.3 135.2-150.47 89.179-259.14 201.46-323.02 333.71-65.54 135.72-98.77 374.85-98.77 710.74v1419.24l-48.491-37.96c-400.308-313.35-629.89-783.49-629.89-1289.87 0-902.87 734.531-1637.411 1637.391-1637.411 111.23 0 222.24 11.269 330.54 33.543v-322.4534c-108.89-18.6289-219.96-28.0469-330.54-28.0469" fill="url(#d)"/></g></g></svg>

After

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.1 KiB

View file

@ -0,0 +1 @@
<svg height="700pt" preserveAspectRatio="xMidYMid meet" viewBox="0 0 700 700" width="700pt" xmlns="http://www.w3.org/2000/svg"><g transform="matrix(.1 0 0 -.1 0 700)"><path d="m3278 6996c-1-2-41-6-88-10-98-8-120-11-252-33-87-14-98-18-99-37-7-128-2-656 6-656 6 0 28 5 50 10 55 12 89 18 170 31 39 5 84 12 100 15 51 8 245 18 350 18 249 0 499-35 752-105l113-31 2-2404 3-2403 85 52c133 81 196 131 315 251 170 173 298 369 360 557 28 84 27 77 48 209 46 276 50 435 51 1937 1 727 4 1324 6 1327 13 12 304-264 415-394 161-189 328-458 442-715 28-64 118-318 128-362 2-10 15-67 29-128 14-60 27-128 31-150 3-22 7-53 10-70 12-75 15-106 22-190 12-155 6-443-11-545-3-14-7-47-11-75-3-27-8-59-10-70-3-11-7-31-9-45-66-371-224-753-446-1076-250-365-578-664-977-888-123-69-360-174-444-196l-39-11v-348-349l113 33c454 136 815 328 1231 655 56 43 241 218 313 293 479 507 792 1130 912 1817 11 63 23 142 26 175 4 33 9 71 11 85 9 48 11 525 4 605-17 176-22 220-25 225-2 3-6 30-10 60-7 55-58 298-75 355-98 332-208 594-352 839-391 663-964 1169-1666 1469-297 127-647 220-957 253-27 3-63 8-80 10-34 6-541 14-547 10z"/><path d="m2585 6879c-96-22-409-132-429-150-6-5-16-9-23-9-20 0-297-139-404-203-260-155-464-313-675-522-184-183-222-226-344-386-288-382-491-802-603-1254-77-309-102-518-102-860 1-194 7-327 20-406 2-13 6-46 10-74 9-76 16-116 25-160 5-22 11-53 14-70 29-160 113-433 193-625 142-346 374-711 633-1000 92-102 273-277 359-346 13-10 28-24 35-29 51-48 406-295 422-295 2 0 23-12 45-26 59-37 278-145 389-192 269-114 649-215 920-246 292-34 694-28 948 13 37 6 78 13 92 15l25 3v338l1 337-36-5c-19-3-89-15-155-26-230-39-591-46-795-15-315 47-550 113-799 223-186 83-415 217-556 328-16 13-35 27-40 31-90 64-340 307-431 417-303 367-504 781-597 1230-22 106-29 144-43 255-22 166-22 556 0 666 2 12 7 45 11 75 7 58 44 236 69 334 33 132 126 375 197 517 61 121 221 385 248 408 3 3 26 32 50 65 25 33 47 62 50 65s40 43 81 89c62 70 127 136 234 237 16 14 126 104 129 104 1 0 2-593 3-1318 1-1162 5-1521 19-1612 2-14 6-56 10-95 3-38 8-81 10-95s7-45 10-70c48-362 168-617 395-839 261-255 616-426 989-475 281-37 603-21 860 43 46 12 84 21 85 21s2 211 1 469c0 311-3 467-10 463-5-3-28-20-50-37-49-39-161-105-179-105-6 0-16-4-22-9-13-14-147-50-229-62-121-18-307-12-400 13-22 5-47 12-55 13-36 8-103 36-166 70-220 119-344 305-379 565-3 25-8 61-12 80-3 19-8 901-10 1960s-4 1981-6 2050l-2 126z"/></g></svg>

After

Width:  |  Height:  |  Size: 2.3 KiB

View file

@ -0,0 +1 @@
<svg fill="#212121" height="700pt" preserveAspectRatio="xMidYMid meet" viewBox="0 0 700 700" width="700pt" xmlns="http://www.w3.org/2000/svg"><g transform="matrix(.1 0 0 -.1 0 700)"><path d="m3278 6996c-1-2-41-6-88-10-98-8-120-11-252-33-87-14-98-18-99-37-7-128-2-656 6-656 6 0 28 5 50 10 55 12 89 18 170 31 39 5 84 12 100 15 51 8 245 18 350 18 249 0 499-35 752-105l113-31 2-2404 3-2403 85 52c133 81 196 131 315 251 170 173 298 369 360 557 28 84 27 77 48 209 46 276 50 435 51 1937 1 727 4 1324 6 1327 13 12 304-264 415-394 161-189 328-458 442-715 28-64 118-318 128-362 2-10 15-67 29-128 14-60 27-128 31-150 3-22 7-53 10-70 12-75 15-106 22-190 12-155 6-443-11-545-3-14-7-47-11-75-3-27-8-59-10-70-3-11-7-31-9-45-66-371-224-753-446-1076-250-365-578-664-977-888-123-69-360-174-444-196l-39-11v-348-349l113 33c454 136 815 328 1231 655 56 43 241 218 313 293 479 507 792 1130 912 1817 11 63 23 142 26 175 4 33 9 71 11 85 9 48 11 525 4 605-17 176-22 220-25 225-2 3-6 30-10 60-7 55-58 298-75 355-98 332-208 594-352 839-391 663-964 1169-1666 1469-297 127-647 220-957 253-27 3-63 8-80 10-34 6-541 14-547 10z"/><path d="m2585 6879c-96-22-409-132-429-150-6-5-16-9-23-9-20 0-297-139-404-203-260-155-464-313-675-522-184-183-222-226-344-386-288-382-491-802-603-1254-77-309-102-518-102-860 1-194 7-327 20-406 2-13 6-46 10-74 9-76 16-116 25-160 5-22 11-53 14-70 29-160 113-433 193-625 142-346 374-711 633-1000 92-102 273-277 359-346 13-10 28-24 35-29 51-48 406-295 422-295 2 0 23-12 45-26 59-37 278-145 389-192 269-114 649-215 920-246 292-34 694-28 948 13 37 6 78 13 92 15l25 3v338l1 337-36-5c-19-3-89-15-155-26-230-39-591-46-795-15-315 47-550 113-799 223-186 83-415 217-556 328-16 13-35 27-40 31-90 64-340 307-431 417-303 367-504 781-597 1230-22 106-29 144-43 255-22 166-22 556 0 666 2 12 7 45 11 75 7 58 44 236 69 334 33 132 126 375 197 517 61 121 221 385 248 408 3 3 26 32 50 65 25 33 47 62 50 65s40 43 81 89c62 70 127 136 234 237 16 14 126 104 129 104 1 0 2-593 3-1318 1-1162 5-1521 19-1612 2-14 6-56 10-95 3-38 8-81 10-95s7-45 10-70c48-362 168-617 395-839 261-255 616-426 989-475 281-37 603-21 860 43 46 12 84 21 85 21s2 211 1 469c0 311-3 467-10 463-5-3-28-20-50-37-49-39-161-105-179-105-6 0-16-4-22-9-13-14-147-50-229-62-121-18-307-12-400 13-22 5-47 12-55 13-36 8-103 36-166 70-220 119-344 305-379 565-3 25-8 61-12 80-3 19-8 901-10 1960s-4 1981-6 2050l-2 126z"/></g></svg>

After

Width:  |  Height:  |  Size: 2.3 KiB

7
docs/getting-started.md Normal file
View file

@ -0,0 +1,7 @@
---
title: Get Started
---
# Getting Started
Coming soon...

4
docs/index.md Normal file
View file

@ -0,0 +1,4 @@
---
title: ModernUO
template: home.html
---

View file

@ -0,0 +1 @@
<svg height="529.15997" viewBox="0 0 529.15997 529.15997" width="529.15997" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><clipPath id="a"><path d="m2512.85 434.602c664.19 226.828 1108.92 846.878 1108.92 1549.778 0 506.38-229.59 976.52-629.89 1289.87l-48.49 37.96v-1419.24c0-285.63-16.44-484.51-48.85-591.12-31.25-102.71-92.53-204.08-182.15-301.28-59.65-64.691-126.61-118.961-199.54-161.781v2695.511l-20.68 6.77c-163.79 53.55-334.64 80.71-507.81 80.71-116.47 0-232.75-12.43-346.2-36.98v323.08c114.09 20.48 230.43 30.86 346.2 30.86 1077.66 0 1954.37-876.72 1954.37-1954.36 0-877.2-584.34-1645.45-1425.88-1881.771z"/></clipPath><linearGradient id="b" gradientTransform="matrix(0 -3981.4 -3981.4 0 2788.45 3927.9)" gradientUnits="userSpaceOnUse" spreadMethod="pad" x1="0" x2="1" y1="0" y2="0"><stop offset="0" stop-color="#bfbdbb"/><stop offset=".248485" stop-color="#fbfcfc"/><stop offset=".484848" stop-color="#959696"/><stop offset=".70303" stop-color="#f0f0f0"/><stop offset="1" stop-color="#8d8d8d"/></linearGradient><clipPath id="c"><path d="m1984.36 30.0117c-1077.637 0-1954.36 876.7073-1954.36 1954.3683 0 877.19 584.355 1645.42 1425.89 1881.75v-2120.73c0-174.88 16.68-297.63 50.98-375.3 36.14-81.88 96.23-147.98 178.61-196.45 80.54-47.37 177.6-71.39 288.48-71.39 116.83 0 219.8 26.54 306.04 78.89 12.05 7.32 23.7 15.02 34.9 23.06v-449.19c-98.23-27.68-208.6-41.7-328.46-41.7-206.52 0-387.97 45.481-539.3 135.2-150.47 89.179-259.14 201.46-323.02 333.71-65.54 135.72-98.77 374.85-98.77 710.74v1419.24l-48.491-37.96c-400.308-313.35-629.89-783.49-629.89-1289.87 0-902.87 734.531-1637.411 1637.391-1637.411 111.23 0 222.24 11.269 330.54 33.543v-322.4534c-108.89-18.6289-219.96-28.0469-330.54-28.0469z"/></clipPath><linearGradient id="d" gradientTransform="matrix(0 -3981.4 -3981.4 0 1172.45 3927.91)" gradientUnits="userSpaceOnUse" spreadMethod="pad" x1="0" x2="1" y1="0" y2="0"><stop offset="0" stop-color="#ae9964"/><stop offset=".248485" stop-color="#fbe383"/><stop offset=".484848" stop-color="#8d7036"/><stop offset=".714286" stop-color="#c9b14e"/><stop offset="1" stop-color="#7f6740"/></linearGradient><g transform="matrix(.13333333 0 0 -.13333333 0 529.16)"><path d="m1984.36 3968.74c-128.6 0-254.34-12.45-376.2-35.93v-385.64c120.72 29.1 246.68 44.61 376.2 44.61 173.94 0 341.47-27.89 498.49-79.23v-2724.37c92.71 47.199 177.2 111.371 251.6 192.058 92.7 100.542 156.23 205.822 188.8 312.892 33.27 109.43 50.14 311.26 50.14 599.84v1357.66c376.17-294.47 618.38-752.6 618.38-1266.25 0-712.39-465.88-1317.919-1108.92-1528.189v-392.7613c853.7 221.6793 1485.88 998.8603 1485.88 1920.9503 0 1094.17-890.17 1984.36-1984.37 1984.36" fill="#dfdfdd"/><g clip-path="url(#a)"><path d="m2512.85 434.602c664.19 226.828 1108.92 846.878 1108.92 1549.778 0 506.38-229.59 976.52-629.89 1289.87l-48.49 37.96v-1419.24c0-285.63-16.44-484.51-48.85-591.12-31.25-102.71-92.53-204.08-182.15-301.28-59.65-64.691-126.61-118.961-199.54-161.781v2695.511l-20.68 6.77c-163.79 53.55-334.64 80.71-507.81 80.71-116.47 0-232.75-12.43-346.2-36.98v323.08c114.09 20.48 230.43 30.86 346.2 30.86 1077.66 0 1954.37-876.72 1954.37-1954.36 0-877.2-584.34-1645.45-1425.88-1881.771v331.993" fill="url(#b)"/></g><path d="m1973.96 1132.26c-105.46 0-197.39 22.62-273.26 67.24-76.85 45.22-132.83 106.7-166.38 182.71-32.59 73.78-48.43 192.58-48.43 363.19v1226.51 540.64 392.76c-853.699-221.68-1485.89-998.85-1485.89-1920.93 0-1094.2 890.184-1984.3682812 1984.36-1984.3682812 123.1 0 243.58 11.3476812 360.54 32.9179812v384.8203c-115.94-26.668-236.61-40.781-360.54-40.781-886.32 0-1607.391 721.081-1607.391 1607.411 0 513.65 242.207 971.78 618.383 1266.25v-1357.66c0-340.44 34.228-583.96 101.758-723.78 66.48-137.66 179.09-254.221 334.73-346.471 156.02-92.489 342.61-139.387 554.6-139.387 132.62 0 252.67 16.719 358.46 49.25v535.068c-23.54-22.21-50.33-42.57-80.46-60.85-81.5-49.46-179.23-74.54-290.48-74.54" fill="#e9cf72"/><g clip-path="url(#c)"><path d="m1984.36 30.0117c-1077.637 0-1954.36 876.7073-1954.36 1954.3683 0 877.19 584.355 1645.42 1425.89 1881.75v-2120.73c0-174.88 16.68-297.63 50.98-375.3 36.14-81.88 96.23-147.98 178.61-196.45 80.54-47.37 177.6-71.39 288.48-71.39 116.83 0 219.8 26.54 306.04 78.89 12.05 7.32 23.7 15.02 34.9 23.06v-449.19c-98.23-27.68-208.6-41.7-328.46-41.7-206.52 0-387.97 45.481-539.3 135.2-150.47 89.179-259.14 201.46-323.02 333.71-65.54 135.72-98.77 374.85-98.77 710.74v1419.24l-48.491-37.96c-400.308-313.35-629.89-783.49-629.89-1289.87 0-902.87 734.531-1637.411 1637.391-1637.411 111.23 0 222.24 11.269 330.54 33.543v-322.4534c-108.89-18.6289-219.96-28.0469-330.54-28.0469" fill="url(#d)"/></g></g></svg>

After

Width:  |  Height:  |  Size: 4.5 KiB

152
docs/overrides/home.html Normal file
View file

@ -0,0 +1,152 @@
{% extends "main.html" %}
<!-- Render hero under tabs -->
{% block tabs %}
{{ super() }}
<style>
/* Remove spacing, as we cannot hide it completely */
.md-main__inner {
margin: 0;
}
/* Hide main content for now */
.md-content {
display: none;
}
/* Hide table of contents */
@media screen and (min-width: 60em) {
.md-sidebar--secondary {
display: none;
}
}
/* Hide navigation */
@media screen and (min-width: 76.25em) {
.md-sidebar--primary {
display: none;
}
}
.md-main {
background: var(--md-default-fg-color);
}
.md-typeset h1 {
color: var(--md-default-bg-color--light);
}
.tx-container {
background: var(--md-default-fg-color);
padding-top: 1rem;
}
.tx-hero {
display: flex;
align-content: center;
justify-content: center;
flex-direction: column;
min-height: 400px;
margin: 0 0.8rem;
}
.tx-hero div {
padding-top: 0.5rem;
padding-bottom: 0.5rem;
}
.tx-hero__image {
text-align: center;
}
.tx-hero__content {
text-align: center;
}
.tx-hero__content .md-button {
background-color: transparent;
color: var(--md-primary-bg-color--light);
border-color: var(--md-primary-bg-color--light);
}
.tx-hero__content .md-button--primary {
background-color: var(--muo-gold);
color: var(--md-primary-fg-color);
border-color: transparent;
}
.tx-hero__content .md-button:hover {
border-color: transparent;
color: var(--md-primary-fg-color);
background-color: var(--md-primary-bg-color);
}
.tx-hero__content .md-button--primary:hover {
border-color: var(--md-primary-bg-color--light);
}
/*@media screen and (max-width: 60em)*/
/*{*/
/* .tx-hero__image img {*/
/* max-width: 64px;*/
/* }*/
/*}*/
@media screen and (max-width: 60em)
{
.tx-hero__image img {
max-width: 128px;
}
}
@media screen and (min-width: 60em)
{
.tx-hero__image img {
max-width: 200px;
}
}
</style>
<!-- Hero for landing page -->
<section class="tx-container">
<div class="md-grid md-typeset">
<div class="tx-hero">
<div class="tx-hero__image">
<img
src="/branding/logo.svg"
alt=""
draggable="false"
>
</div>
<!-- Hero content -->
<div class="tx-hero__content">
<h1>Ultima Online Server Emulator for the modern era!</h1>
<a
href="{{ page.next_page.url | url }}"
title="{{ page.next_page.title | striptags }}"
class="md-button md-button--primary"
>
Get started
</a>
<a
href="{{ config.repo_url }}"
title="{{ lang.t('source.link.title') }}"
class="md-button"
>
Go to GitHub
</a>
</div>
</div>
</div>
</section>
{% endblock %}
<!-- Content -->
{% block content %}{% endblock %}
<!-- Application footer -->
{% block footer %}
{% include "partials/footer.html" %}
{% endblock %}

48
docs/overrides/main.html Normal file
View file

@ -0,0 +1,48 @@
{% extends "base.html" %}
<!-- Custom front matter -->
{% block extrahead %}
<!-- Determine title -->
{% set title = config.site_name %}
{% if page and page.title and not page.is_homepage %}
{% set title = config.site_name ~ " - " ~ page.title | striptags %}
{% endif %}
<!-- The image needs to have an absolute URL -->
{% set image = config.site_url ~ 'assets/images/logo.svg' %}
<!-- Open graph meta tags -->
<meta property="og:type" content="website" />
<meta property="og:title" content="{{ title }}" />
<meta property="og:description" content="{{ config.site_description }}" />
<meta property="og:url" content="{{ page.canonical_url }}" />
<meta property="og:image" content="{{ image }}" />
<meta property="og:image:type" content="image/png" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
<!-- Twitter meta tags -->
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:site" content="@modernuo" />
<meta name="twitter:creator" content="@modernuo" />
<meta name="twitter:title" content="{{ title }}" />
<meta name="twitter:description" content="{{ config.site_description }}" />
<meta name="twitter:image" content="{{ image }}" />
<!-- Extra stylesheets -->
<link
rel="stylesheet"
href="{{ 'assets/stylesheets/overrides.css' | url }}"
/>
{% endblock %}
<!-- Content -->
{% block content %}
{{ super() }}
<!-- Content footer -->
<footer class="tx-content__footer md-typeset">
</footer>
{% endblock %}

View file

@ -0,0 +1,97 @@
<!--
Copyright (c) 2016-2020 Martin Donath <martin.donath@squidfunk.com>
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.
-->
{% import "partials/language.html" as lang with context %}
<!-- Application footer -->
<footer class="md-footer">
<!-- Link to previous and/or next page -->
{% if page.previous_page or page.next_page %}
<div class="md-footer-nav">
<nav
class="md-footer-nav__inner md-grid"
aria-label="{{ lang.t('footer.title') }}"
>
<!-- Link to previous page -->
{% if page.previous_page %}
<a
href="{{ page.previous_page.url | url }}"
title="{{ page.previous_page.title | striptags }}"
class="md-footer-nav__link md-footer-nav__link--prev"
rel="prev"
>
<div class="md-footer-nav__button md-icon">
{% include ".icons/material/arrow-left.svg" %}
</div>
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
{{ lang.t("footer.previous") }}
</span>
{{ page.previous_page.title }}
</div>
</div>
</a>
{% endif %}
<!-- Link to next page -->
{% if page.next_page %}
<a
href="{{ page.next_page.url | url }}"
title="{{ page.next_page.title | striptags }}"
class="md-footer-nav__link md-footer-nav__link--next"
rel="next"
>
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
{{ lang.t("footer.next") }}
</span>
{{ page.next_page.title }}
</div>
</div>
<div class="md-footer-nav__button md-icon">
{% include ".icons/material/arrow-right.svg" %}
</div>
</a>
{% endif %}
</nav>
</div>
{% endif %}
<!-- Further information -->
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<!-- Copyright and theme information -->
<div class="md-footer-copyright">
{% if config.copyright %}
<div class="md-footer-copyright__highlight">
{{ config.copyright }}
</div>
{% endif %}
</div>
<!-- Social links -->
{% include "partials/social.html" %}
</div>
</div>
</footer>

View file

@ -0,0 +1,83 @@
<!--
Copyright (c) 2016-2020 Martin Donath <martin.donath@squidfunk.com>
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.
-->
<!-- Application header -->
<header class="md-header" data-md-component="header">
<!-- Top-level navigation -->
<nav class="md-header-nav md-grid" aria-label="{{ lang.t('header.title') }}">
<!-- Link to home -->
<a
href="{{ config.site_url | default(nav.homepage.url, true) | url }}"
title="{{ config.site_name }}"
class="md-header-nav__button md-logo"
aria-label="{{ config.site_name }}"
>
{% include "partials/logo.html" %}
</a>
<!-- Button to open drawer -->
<label class="md-header-nav__button md-icon" for="__drawer">
{% include ".icons/material/menu" ~ ".svg" %}
</label>
<!-- Header title -->
<div class="md-header-nav__title" data-md-component="header-title">
{% if config.site_name == page.title %}
<div class="md-header-nav__ellipsis md-ellipsis">
{{ config.site_name }}
</div>
{% else %}
<div class="md-header-nav__ellipsis">
<span class="md-header-nav__topic md-ellipsis">
{{ config.site_name }}
</span>
<span class="md-header-nav__topic md-ellipsis">
{% if page and page.meta and page.meta.title %}
{{ page.meta.title }}
{% else %}
{{ page.title }}
{% endif %}
</span>
</div>
{% endif %}
</div>
<!-- Button to open search dialogue -->
{% if "search" in config["plugins"] %}
<label class="md-header-nav__button md-icon" for="__search">
{% include ".icons/material/magnify.svg" %}
</label>
<!-- Search interface -->
{% include "partials/search.html" %}
{% endif %}
<!-- Repository containing source -->
{% if config.repo_url %}
<div class="md-header-nav__source">
{% include "partials/source.html" %}
</div>
{% endif %}
</nav>
</header>

View file

@ -0,0 +1,69 @@
<!--
Copyright (c) 2016-2020 Martin Donath <martin.donath@squidfunk.com>
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.
-->
<!-- Main navigation -->
<nav
class="md-nav md-nav--primary"
aria-label="{{ lang.t('nav.title') }}"
data-md-level="0"
>
<!-- Site title -->
<label class="md-nav__title" for="__drawer">
<a
href="{{ config.site_url | default(nav.homepage.url, true) | url }}"
title="{{ config.site_name }}"
class="md-nav__button md-logo"
aria-label="{{ config.site_name }}"
>
{% include "partials/logo.html" %}
</a>
{{ config.site_name }}
</label>
<!-- Repository containing source -->
{% if config.repo_url %}
<div class="md-nav__source">
{% include "partials/source.html" %}
</div>
{% endif %}
<!-- Render item list -->
<ul class="md-nav__list" data-md-scrollfix>
{% for nav_item in nav %}
{% set path = "nav-" + loop.index | string %}
{% set level = 1 %}
{% include "partials/nav-item.html" %}
{% endfor %}
<li class="md-nav__item">
<a class="md-nav__link" href="https://discord.gg/DHkNUsq" target="_blank">
<img src="https://img.shields.io/discord/751317910504603701?logo=discord&style=social" alt="Discord" />
</a>
<a class="md-nav__link" href="https://www.reddit.com/r/modernuo" target="_blank">
<img src="https://img.shields.io/reddit/subreddit-subscribers/modernuo?style=social&label=/r/modernuo" alt="/r/modernuo" />
</a>
<a class="md-nav__link" href="https://www.twitter.com/modernuo" target="_blank">
<img src="https://img.shields.io/twitter/follow/modernuo?label=@modernuo&style=social" alt="@modernuo" />
</a>
<a class="md-nav__link" href="https://gitter.im/modernuo/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge" target="_blank">
<img src="https://img.shields.io/gitter/room/modernuo/modernuo?logo=gitter&logoColor=46BC99&style=social" alt="Gitter" />
</a>
</li>
</ul>
</nav>

64
mkdocs.yml Normal file
View file

@ -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