monero-docs/mkdocs.yml

198 lines
5.7 KiB
YAML
Raw Normal View History

2017-12-22 22:11:36 +00:00
# Project information
2018-08-27 11:25:47 +00:00
site_name: Monero Documentation
2017-12-22 22:11:36 +00:00
site_description: 'Unofficial Monero Documentation'
site_author: "Piotr 'Qertoip' Włodarek"
site_url: 'https://docs.getmonero.org'
site_dir: 'public'
2017-12-22 22:11:36 +00:00
2021-01-22 14:04:23 +00:00
copyright: '© 2021 MoneroDocs under <a href="https://opensource.org/licenses/MIT">MIT</a>'
2018-08-18 14:55:44 +00:00
nav:
2017-12-23 01:35:50 +00:00
- Home: 'index.md'
- Interacting:
2018-10-28 18:05:01 +00:00
- Download: 'interacting/download-monero-binaries.md'
- Verify: 'interacting/verify-monero-binaries.md'
- Overview: 'interacting/overview.md'
- Config file: 'interacting/monero-config-file.md'
- monerod: 'interacting/monerod-reference.md'
- monero-wallet-cli: 'interacting/monero-wallet-cli-reference.md'
2018-10-31 16:45:57 +00:00
- monero-wallet-gui: 'interacting/monero-wallet-gui-reference.md'
- monero-wallet-rpc: 'interacting/monero-wallet-rpc-reference.md'
2018-11-02 12:41:32 +00:00
- monero-blockchain-export: 'interacting/monero-blockchain-export-reference.md'
2018-11-02 17:06:03 +00:00
- monero-blockchain-import: 'interacting/monero-blockchain-import-reference.md'
2018-01-06 13:41:04 +00:00
- Technical specs: 'technical-specs.md'
2018-01-03 11:10:56 +00:00
- Cryptography:
2018-01-09 13:42:16 +00:00
- Introduction: 'cryptography/introduction.md'
2018-01-06 13:41:04 +00:00
- Asymmetric:
2018-01-09 13:42:16 +00:00
- Introduction: 'cryptography/asymmetric/introduction.md'
- Private keys: 'cryptography/asymmetric/private-key.md'
- Public keys: 'cryptography/asymmetric/public-key.md'
- Edwards25519 curve: 'cryptography/asymmetric/edwards25519.md'
2018-01-11 21:52:20 +00:00
- Key image: 'cryptography/asymmetric/key-image.md'
2018-01-05 16:36:27 +00:00
- Base58: 'cryptography/base58.md'
- PRNG: 'cryptography/prng.md'
- 'Keccak-256': 'cryptography/keccak-256.md'
2017-12-23 01:35:50 +00:00
- Address:
- Standard: 'public-address/standard-address.md'
2018-01-02 15:22:23 +00:00
- Subaddress: 'public-address/subaddress.md'
- Integrated: 'public-address/integrated-address.md'
- Proof of Work:
- What is PoW?: 'proof-of-work/what-is-pow.md'
- PoW in Cryptocurrencies: 'proof-of-work/pow-in-cryptocurrencies.md'
- CryptoNight: 'proof-of-work/cryptonight.md'
2020-04-12 20:04:25 +00:00
- RandomX: 'proof-of-work/random-x.md'
2018-01-02 15:22:23 +00:00
- Multisignature: 'multisignature.md'
2018-09-21 14:45:07 +00:00
- Infrastructure:
- Mainnet, stagenet, testnet: 'infrastructure/networks.md'
- Tor onion seed nodes: 'infrastructure/tor-onion-p2p-seed-nodes.md'
2018-09-21 14:45:07 +00:00
- MoneroPulse: 'infrastructure/monero-pulse.md'
- Running a Node:
# - On your Laptop: 'localhost-node.md'
# - Remote Node: 'remote-node.md'
# - Open Remote Node: 'open-remote-node.md'
- Open Node + Tor Onion: 'running-node/open-node-tor-onion.md'
- Cold storage:
- Offline Transaction Signing: 'cold-storage/offline-transaction-signing.md'
2019-01-28 10:39:03 +00:00
- Accepting Monero:
- Overview: 'accepting-monero/overview.md'
2017-12-23 01:35:50 +00:00
2017-12-22 22:11:36 +00:00
theme:
name: material
#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
2017-12-22 22:11:36 +00:00
palette:
- media: "(prefers-color-scheme)"
2021-11-15 21:53:01 +00:00
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: images/favicon.ico
2021-01-22 14:04:23 +00:00
icon:
logo: logo
logo: 'images/monero.svg'
2017-12-23 01:35:50 +00:00
extra_css: ['overrides.css']
2017-12-23 01:35:50 +00:00
repo_name: 'monero-project/monero-docs'
repo_url: 'https://github.com/monero-project/monero-docs'
edit_uri: blob/test/docs/
2018-01-06 13:41:04 +00:00
markdown_extensions:
# https://squidfunk.github.io/mkdocs-material/extensions/admonition/
- admonition
- abbr
- def_list
- footnotes
- meta
- toc:
2018-01-06 13:41:04 +00:00
permalink: true
- pymdownx.details
- pymdownx.highlight:
use_pygments: true # build time highlighting, not client side
- pymdownx.inlinehilite
- pymdownx.superfences # nest code blocks inside codeblocks
- pymdownx.snippets # insert content from other files
- tables
2021-01-22 14:04:23 +00:00
plugins:
- search
- minify:
minify_html: true
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