From 87f5842f5d93aa8d9271af4a3a190706e1b3e6bb Mon Sep 17 00:00:00 2001
From: plowsof <plowsof@protonmail.com>
Date: Thu, 1 Aug 2024 14:36:49 +0100
Subject: [PATCH] Improvements/Updates
- add default material theme config options
- add privacy + tables plugin
- add i18n plugin + locales
- replace 404.html with template
- add default favicon
---
404.html | 400 +---------------------------------------
docs/images/favicon.ico | Bin 0 -> 1150 bytes
mkdocs.yml | 131 ++++++++++---
3 files changed, 109 insertions(+), 422 deletions(-)
create mode 100644 docs/images/favicon.ico
diff --git a/404.html b/404.html
index 012910e..7e54fc8 100644
--- a/404.html
+++ b/404.html
@@ -1,396 +1,4 @@
-
-
-
-
-<!DOCTYPE html>
-<html lang="en" class="no-js">
- <head>
-
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1">
- <meta http-equiv="x-ua-compatible" content="ie=edge">
-
- <meta name="description" content="Unofficial Monero Documentation">
-
-
-
- <meta name="author" content="Piotr 'Qertoip' Włodarek">
-
-
- <meta name="lang:clipboard.copy" content="Copy to clipboard">
-
- <meta name="lang:clipboard.copied" content="Copied to clipboard">
-
- <meta name="lang:search.language" content="en">
-
- <meta name="lang:search.result.none" content="No matching documents">
-
- <meta name="lang:search.result.one" content="1 matching document">
-
- <meta name="lang:search.result.other" content="# matching documents">
-
- <meta name="lang:search.tokenizer" content="[\s\-]+">
-
- <link rel="shortcut icon" href="/assets/images/favicon.png">
- <meta name="generator" content="mkdocs-0.17.2, mkdocs-material-2.2.1">
-
-
-
- <title>Monero Docs</title>
-
-
-
- <link rel="stylesheet" href="/assets/stylesheets/application.41c6761c.css">
-
- <link rel="stylesheet" href="/assets/stylesheets/application-palette.792431c1.css">
-
-
-
- <script src="/assets/javascripts/modernizr.1aa3b519.js"></script>
-
-
-
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
- <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
-
- <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
-
-
- <link rel="stylesheet" href="/extra.css">
-
-
- </head>
-
-
-
-
- <body data-md-color-primary="indigo" data-md-color-accent="indigo">
-
-
- <svg class="md-svg">
- <defs>
-
-
- <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
-
- </defs>
- </svg>
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="search">
- <label class="md-overlay" data-md-component="overlay" for="drawer"></label>
-
- <header class="md-header" data-md-component="header">
- <nav class="md-header-nav md-grid">
- <div class="md-flex">
- <div class="md-flex__cell md-flex__cell--shrink">
- <a href="https://monerodocs.org/" title="Monero Docs" class="md-header-nav__button md-logo">
-
- <i class="md-icon"></i>
-
- </a>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
- <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
- </div>
- <div class="md-flex__cell md-flex__cell--stretch">
- <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-
-
- <span class="md-header-nav__topic">
- Monero Docs
- </span>
- <span class="md-header-nav__topic">
-
- </span>
-
-
- </div>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
-
-
- <label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
-
-<div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="search"></label>
- <div class="md-search__inner">
- <form class="md-search__form" name="search">
- <input type="text" class="md-search__input" name="query" required placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
- <label class="md-icon md-search__icon" for="search"></label>
- <button type="reset" class="md-icon md-search__icon" data-md-component="reset"></button>
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" data-md-scrollfix>
- <div class="md-search-result" data-md-component="result">
- <div class="md-search-result__meta">
- Type to start searching
- </div>
- <ol class="md-search-result__list"></ol>
- </div>
- </div>
- </div>
- </div>
-</div>
-
-
- </div>
-
- <div class="md-flex__cell md-flex__cell--shrink">
- <div class="md-header-nav__source">
-
-
-
-
-
-
- <a href="https://github.com/monerodocs/md/" title="Go to repository" class="md-source" data-md-source="github">
-
- <div class="md-source__icon">
- <svg viewBox="0 0 24 24" width="24" height="24">
- <use xlink:href="#github" width="24" height="24"></use>
- </svg>
- </div>
-
- <div class="md-source__repository">
- monerodocs/md
- </div>
- </a>
-
- </div>
- </div>
-
- </div>
- </nav>
-</header>
-
- <div class="md-container">
-
-
-
-
- <main class="md-main">
- <div class="md-main__inner md-grid" data-md-component="container">
-
-
- <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
- <nav class="md-nav md-nav--primary" data-md-level="0">
- <label class="md-nav__title md-nav__title--site" for="drawer">
- <span class="md-nav__button md-logo">
-
- <i class="md-icon"></i>
-
- </span>
- Monero Docs
- </label>
-
- <div class="md-nav__source">
-
-
-
-
-
-
- <a href="https://github.com/monerodocs/md/" title="Go to repository" class="md-source" data-md-source="github">
-
- <div class="md-source__icon">
- <svg viewBox="0 0 24 24" width="24" height="24">
- <use xlink:href="#github" width="24" height="24"></use>
- </svg>
- </div>
-
- <div class="md-source__repository">
- monerodocs/md
- </div>
- </a>
-
- </div>
-
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="/" title="Home" class="md-nav__link">
- Home
- </a>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="/Technical-Specs/" title="Technical Specs" class="md-nav__link">
- Technical Specs
- </a>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
-
- <label class="md-nav__link" for="nav-3">
- Primitives
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-3">
- Primitives
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="/primitives/Base58/" title="Base 58" class="md-nav__link">
- Base 58
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
-
- <label class="md-nav__link" for="nav-4">
- Address
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-4">
- Address
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="/public-address/Standard-Address/" title="Standard" class="md-nav__link">
- Standard
- </a>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="/public-address/Integrated-Address/" title="Integrated" class="md-nav__link">
- Integrated
- </a>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="/public-address/Subaddress/" title="Subaddress" class="md-nav__link">
- Subaddress
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="/Multisignature/" title="Multisignature" class="md-nav__link">
- Multisignature
- </a>
- </li>
-
-
- </ul>
-</nav>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-content">
- <article class="md-content__inner md-typeset">
-
- <h1>404 - Not found</h1>
-
-
-
-
- </article>
- </div>
- </div>
- </main>
-
-
-<footer class="md-footer">
-
- <div class="md-footer-meta md-typeset">
- <div class="md-footer-meta__inner md-grid">
- <div class="md-footer-copyright">
-
- powered by
- <a href="http://www.mkdocs.org">MkDocs</a>
- and
- <a href="https://squidfunk.github.io/mkdocs-material/">
- Material for MkDocs</a>
- </div>
-
-
-
- </div>
- </div>
-</footer>
-
- </div>
-
- <script src="/assets/javascripts/application.5165553b.js"></script>
-
- <script>app.initialize({version:"0.17.2",url:{base:""}})</script>
-
-
-
-
-
- </body>
-</html>
\ No newline at end of file
+{% extends "main.html" %}
+{% block content %}
+ <h1>401 - Unauthorized</h1>
+{% endblock %}
\ No newline at end of file
diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..e85006a3ce1c6fd81faa6d5a13095519c4a6fc96
GIT binary patch
literal 1150
zcmd6lF-yZh9L1kl>(HSEK`2y^4yB6->f+$wD)=oNY!UheIt03Q=;qj=;8*Bap_4*&
za8yAl;wmmx5Yyi^7dXN-WYdJ-{qNqpcez|5t#Fr0qTSYcPTG`I2PBk8r$~4kg^0zN
zCJe(rhix3do!L$bZ+IuZ{i08x=JR3=e+M4pv0KsKA??{u_*EFfo|`p&t`Vf=jn{)F
z1fKk9hWsmYwqWAP^JO*5u*R;*L&dX3H$%S7oB$f0{ISh{QVXuncnzN67WQH2`lip7
zhX+VI$6x$1+$8gMjh4+1l0N#8_0Fh=N#EwpKk{SeE!)SHFB@xQFX3y+8sF#_@!bDW
eIdI-IC`$c%>bk?KbPeN9RHtL<1^)v~#xMt8oB^@`
literal 0
HcmV?d00001
diff --git a/mkdocs.yml b/mkdocs.yml
index 89a600c..d36f51e 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -2,7 +2,7 @@
site_name: Monero Documentation
site_description: 'Unofficial Monero Documentation'
site_author: "Piotr 'Qertoip' Włodarek"
-site_url: 'https://monerodocs.org'
+site_url: 'https://md2.monerodevs.org'
site_dir: 'public'
copyright: '© 2021 MoneroDocs under <a href="https://opensource.org/licenses/MIT">MIT</a>'
@@ -58,41 +58,69 @@ nav:
theme:
- name: null
- custom_dir: mkdocs-material/material
-
- # 404 page
- static_templates:
- - 404.html
-
- # Necessary for search to work properly
- include_search_page: false
- search_index_only: true
-
- # Default values, taken from mkdocs_theme.yml
- language: en
+ name: material
+ favicon: images/favicon.ico
+ #custom_dir: mkdocs-material/material/overrides
+ features:
+ - announce.dismiss
+ - content.action.edit
+ - content.action.view
+ - content.code.annotate
+ - content.code.copy
+ # - content.code.select
+ # - content.footnote.tooltips
+ # - content.tabs.link
+ - content.tooltips
+ # - header.autohide
+ # - navigation.expand
+ - navigation.footer
+ - navigation.indexes
+ # - navigation.instant
+ # - navigation.instant.prefetch
+ # - navigation.instant.progress
+ # - navigation.prune
+ - navigation.sections
+ - navigation.tabs
+ # - navigation.tabs.sticky
+ - navigation.top
+ - navigation.tracking
+ - search.highlight
+ - search.share
+ - search.suggest
+ - toc.follow
+ # - toc.integrate
+ palette:
+ - media: "(prefers-color-scheme)"
+ toggle:
+ icon: material/weather-sunny
+ name: Switch to light mode
+ - media: "(prefers-color-scheme: light)"
+ scheme: default
+ primary: indigo
+ accent: indigo
+ toggle:
+ icon: material/toggle-switch
+ name: Switch to dark mode
+ - media: "(prefers-color-scheme: dark)"
+ scheme: slate
+ primary: black
+ accent: indigo
+ toggle:
+ icon: material/toggle-switch-off
+ name: Switch to system preference
font:
text: Roboto
code: Roboto Mono
favicon: assets/favicon.png
- palette:
- - scheme: default
- primary: white
- toggle:
- icon: material/weather-night
- name: Switch to dark mode
- - scheme: slate
- toggle:
- icon: material/weather-sunny
- name: Switch to light mode
icon:
logo: logo
logo: 'images/monero.svg'
extra_css: ['overrides.css']
-repo_name: 'monerodocs/md'
-repo_url: 'https://github.com/monerodocs/md'
+repo_name: 'plowsof/monero-docs'
+repo_url: 'https://github.com/plowsof/monero-docs'
+edit_uri: blob/test_test/docs/
markdown_extensions:
# https://squidfunk.github.io/mkdocs-material/extensions/admonition/
@@ -109,6 +137,7 @@ markdown_extensions:
- pymdownx.inlinehilite
- pymdownx.superfences # nest code blocks inside codeblocks
- pymdownx.snippets # insert content from other files
+ - tables
plugins:
- search
@@ -117,3 +146,53 @@ plugins:
minify_js: true
htmlmin_opts:
remove_comments: true
+ - privacy
+ - i18n:
+ docs_structure: folder
+ languages:
+ - locale: en
+ default: true
+ name: English
+ build: true
+ - locale: fr
+ name: Français
+ build: true
+ - locale: es
+ name: Español
+ build: true
+ - locale: it
+ name: Italiano
+ build: true
+ - locale: pl
+ name: Polski
+ build: true
+ - locale: ar
+ name: العربية
+ build: true
+ - locale: ru
+ name: Русский
+ build: true
+ - locale: de
+ name: Deutsch
+ build: true
+ - locale: nl
+ name: Nederlands
+ build: true
+ - locale: pt
+ name: Português
+ build: true
+ - locale: tr
+ name: Türkçe
+ build: true
+ - locale: zh
+ name: 中文 (简体)
+ build: true
+ - locale: zh-TW
+ name: 中文 (繁體)
+ build: true
+ - locale: nb
+ name: Norsk Bokmål
+ build: true
+
+static_templates:
+ - 404.html
\ No newline at end of file