2017-12-22 22:11:36 +00:00
|
|
|
# Project information
|
2024-08-03 20:33:20 +00:00
|
|
|
site_name: Monero Docs
|
|
|
|
site_description: 'Monero Documentation'
|
|
|
|
site_author: "Monero Community"
|
2024-08-01 13:36:49 +00:00
|
|
|
site_url: 'https://docs.getmonero.org'
|
2021-01-21 14:52:04 +00:00
|
|
|
site_dir: 'public'
|
2017-12-22 22:11:36 +00:00
|
|
|
|
2024-08-03 20:33:20 +00:00
|
|
|
copyright: '© 2024 Monero Community under <a href="https://opensource.org/licenses/MIT">MIT</a>'
|
2021-01-22 14:04:23 +00:00
|
|
|
|
2018-08-18 14:55:44 +00:00
|
|
|
nav:
|
2017-12-23 01:35:50 +00:00
|
|
|
- Home: 'index.md'
|
2018-09-07 20:21:19 +00:00
|
|
|
- Interacting:
|
2024-08-29 15:32:37 +00:00
|
|
|
- The Basics:
|
|
|
|
- Overview: 'interacting/overview.md'
|
|
|
|
- Tokenomics: 'technical-specs.md'
|
|
|
|
- Networks: 'infrastructure/networks.md'
|
|
|
|
- Download & Verify:
|
|
|
|
- Download: 'interacting/download-monero-binaries.md'
|
|
|
|
- Verify: 'interacting/verify-monero-binaries.md'
|
|
|
|
- Monerod:
|
|
|
|
- Flags: 'interacting/monerod-reference.md'
|
|
|
|
- Setup Guide:
|
|
|
|
# - I2P: 'running-node/open-node-tor-onion.md' TODO
|
|
|
|
- Tor: 'running-node/open-node-tor-onion.md'
|
|
|
|
- Sample Configs:
|
|
|
|
- VPS: 'interacting/monero-config-file.md'
|
|
|
|
# - Home: 'interacting/moneord-tori2p.md' # TODO
|
|
|
|
- Wallets:
|
|
|
|
- monero-wallet-gui: 'interacting/monero-wallet-gui-reference.md'
|
|
|
|
- monero-wallet-cli: 'interacting/monero-wallet-cli-reference.md'
|
|
|
|
- monero-wallet-rpc: 'interacting/monero-wallet-rpc-reference.md'
|
|
|
|
- Advanced Transactions:
|
|
|
|
- Multisignature: 'multisignature.md'
|
|
|
|
- Offline Transaction Signing: 'cold-storage/offline-transaction-signing.md'
|
|
|
|
- Blockchain Tools:
|
|
|
|
- monero-blockchain-export: 'interacting/monero-blockchain-export-reference.md'
|
|
|
|
- monero-blockchain-import: 'interacting/monero-blockchain-import-reference.md'
|
|
|
|
- External:
|
|
|
|
- MoneroPulse: 'infrastructure/monero-pulse.md'
|
2024-08-29 17:26:07 +00:00
|
|
|
- RPC Library:
|
|
|
|
- Node RPC: 'rpc-library/monerod-rpc.md'
|
|
|
|
- Wallet RPC: 'rpc-library/wallet-rpc.md'
|
2024-08-29 15:32:37 +00:00
|
|
|
- R&D:
|
|
|
|
- Cryptography:
|
2018-01-09 13:42:16 +00:00
|
|
|
- Introduction: 'cryptography/introduction.md'
|
2024-08-29 15:32:37 +00:00
|
|
|
- Asymmetric: # Needs clarity
|
2018-01-09 13:42:16 +00:00
|
|
|
- Introduction: 'cryptography/asymmetric/introduction.md'
|
2018-01-07 16:47:12 +00:00
|
|
|
- Private keys: 'cryptography/asymmetric/private-key.md'
|
|
|
|
- Public keys: 'cryptography/asymmetric/public-key.md'
|
2018-08-20 15:17:45 +00:00
|
|
|
- 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'
|
2024-08-29 15:32:37 +00:00
|
|
|
- Keccak-256: 'cryptography/keccak-256.md'
|
2019-02-21 11:47:22 +00:00
|
|
|
- PRNG: 'cryptography/prng.md'
|
2024-08-29 15:32:37 +00:00
|
|
|
- Address Types:
|
2019-02-21 11:47:22 +00:00
|
|
|
- Standard: 'public-address/standard-address.md'
|
2018-01-02 15:22:23 +00:00
|
|
|
- Subaddress: 'public-address/subaddress.md'
|
2018-08-26 17:50:18 +00:00
|
|
|
- Integrated: 'public-address/integrated-address.md'
|
2024-08-29 15:32:37 +00:00
|
|
|
- Proof of Work: # This section needs improvement
|
2018-11-03 23:42:01 +00:00
|
|
|
- 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'
|
2024-08-29 15:32:37 +00:00
|
|
|
#- Accepting Monero:
|
|
|
|
# - Overview: 'accepting-monero/overview.md'
|
2017-12-23 01:35:50 +00:00
|
|
|
|
2021-04-25 17:25:14 +00:00
|
|
|
|
2017-12-22 22:11:36 +00:00
|
|
|
theme:
|
2024-08-01 13:36:49 +00:00
|
|
|
name: material
|
2024-08-18 15:11:37 +00:00
|
|
|
custom_dir: overrides
|
2024-08-01 13:36:49 +00:00
|
|
|
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
|
2024-09-27 01:44:18 +00:00
|
|
|
# - navigation.path
|
2024-08-01 13:36:49 +00:00
|
|
|
# - navigation.prune
|
2024-09-27 01:44:18 +00:00
|
|
|
# - navigation.sections
|
2024-08-01 13:36:49 +00:00
|
|
|
- navigation.tabs
|
2024-09-27 01:44:18 +00:00
|
|
|
- navigation.tabs.sticky
|
2024-08-01 13:36:49 +00:00
|
|
|
- navigation.top
|
|
|
|
- navigation.tracking
|
|
|
|
- search.highlight
|
|
|
|
- search.share
|
|
|
|
- search.suggest
|
|
|
|
- toc.follow
|
|
|
|
# - toc.integrate
|
2017-12-22 22:11:36 +00:00
|
|
|
palette:
|
2024-08-01 13:36:49 +00:00
|
|
|
- media: "(prefers-color-scheme)"
|
2021-11-15 21:53:01 +00:00
|
|
|
toggle:
|
|
|
|
icon: material/weather-sunny
|
|
|
|
name: Switch to light mode
|
2024-08-01 13:36:49 +00:00
|
|
|
- media: "(prefers-color-scheme: light)"
|
|
|
|
scheme: default
|
2024-09-26 21:09:24 +00:00
|
|
|
primary: custom
|
2024-08-01 13:36:49 +00:00
|
|
|
toggle:
|
|
|
|
icon: material/toggle-switch
|
|
|
|
name: Switch to dark mode
|
|
|
|
- media: "(prefers-color-scheme: dark)"
|
|
|
|
scheme: slate
|
2024-09-26 21:09:24 +00:00
|
|
|
primary: custom
|
2024-08-01 13:36:49 +00:00
|
|
|
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
|
2018-10-19 15:30:00 +00:00
|
|
|
logo: 'images/monero.svg'
|
2024-08-18 21:56:55 +00:00
|
|
|
static_templates:
|
|
|
|
- 404.html
|
2017-12-23 01:35:50 +00:00
|
|
|
|
2024-08-29 20:53:44 +00:00
|
|
|
extra_css:
|
|
|
|
- overrides.css
|
|
|
|
|
|
|
|
extra:
|
|
|
|
social:
|
|
|
|
- icon: material/web
|
|
|
|
link: https://docs.getmonero.org
|
|
|
|
name: Clearnet Website
|
|
|
|
- icon: simple/torbrowser
|
|
|
|
link: http://xmrdoc6phnvjbf5hmjbwdfu47zavzfngymlnwhs2gyxxpxmad4c65kyd.onion
|
|
|
|
name: Tor Onion
|
|
|
|
- icon: custom/i2p
|
|
|
|
link: http://xmrdoc6k4licya7zsnba5s7vugzo72blcpukkvqno75o4ruhaqla.b32.i2p
|
|
|
|
name: I2P Eepsite
|
|
|
|
- icon: fontawesome/brands/github
|
|
|
|
link: https://github.com/monero-project/monero-docs
|
|
|
|
name: GitHub Repository
|
|
|
|
- icon: simple/matrix
|
|
|
|
link: https://matrix.to/#/%23monero-docs:monero.social
|
|
|
|
name: Matrix
|
|
|
|
- icon: simple/liberadotchat
|
|
|
|
link: https://web.libera.chat/#monero-docs
|
|
|
|
name: IRC via Libera.chat
|
2017-12-23 01:35:50 +00:00
|
|
|
|
2024-08-01 13:36:49 +00:00
|
|
|
repo_name: 'monero-project/monero-docs'
|
|
|
|
repo_url: 'https://github.com/monero-project/monero-docs'
|
2024-08-03 20:33:20 +00:00
|
|
|
# todo: change to master branch
|
2024-09-27 08:50:25 +00:00
|
|
|
edit_uri: blob/master/docs/
|
2018-01-06 13:41:04 +00:00
|
|
|
|
|
|
|
markdown_extensions:
|
|
|
|
# https://squidfunk.github.io/mkdocs-material/extensions/admonition/
|
2021-01-14 15:19:37 +00:00
|
|
|
- admonition
|
|
|
|
- abbr
|
|
|
|
- def_list
|
2024-08-30 16:15:45 +00:00
|
|
|
- attr_list
|
2021-01-14 15:19:37 +00:00
|
|
|
- footnotes
|
|
|
|
- meta
|
|
|
|
- toc:
|
2018-01-06 13:41:04 +00:00
|
|
|
permalink: true
|
2024-08-30 16:15:45 +00:00
|
|
|
- pymdownx.emoji:
|
|
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
2021-01-14 15:19:37 +00:00
|
|
|
- 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
|
2024-08-01 13:36:49 +00:00
|
|
|
- tables
|
2021-01-22 14:04:23 +00:00
|
|
|
|
|
|
|
plugins:
|
|
|
|
- search
|
|
|
|
- minify:
|
|
|
|
minify_html: true
|
|
|
|
minify_js: true
|
|
|
|
htmlmin_opts:
|
|
|
|
remove_comments: true
|
2024-08-01 13:36:49 +00:00
|
|
|
- privacy
|
2024-09-19 21:02:58 +00:00
|
|
|
- macros:
|
|
|
|
include_dir: docs/macros/includes
|
|
|
|
include_yaml:
|
|
|
|
- docs/macros/monerod.yml
|
2024-08-01 13:36:49 +00:00
|
|
|
- i18n:
|
|
|
|
docs_structure: folder
|
|
|
|
languages:
|
|
|
|
- locale: en
|
|
|
|
default: true
|
|
|
|
name: English
|
|
|
|
build: true
|
|
|
|
- locale: fr
|
|
|
|
name: Français
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: es
|
|
|
|
name: Español
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: it
|
|
|
|
name: Italiano
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: pl
|
|
|
|
name: Polski
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: ar
|
|
|
|
name: العربية
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: ru
|
|
|
|
name: Русский
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: de
|
|
|
|
name: Deutsch
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: nl
|
|
|
|
name: Nederlands
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: pt
|
|
|
|
name: Português
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: tr
|
|
|
|
name: Türkçe
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: zh
|
|
|
|
name: 中文 (简体)
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: zh-TW
|
|
|
|
name: 中文 (繁體)
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|
2024-08-01 13:36:49 +00:00
|
|
|
- locale: nb
|
|
|
|
name: Norsk Bokmål
|
2024-09-08 21:22:14 +00:00
|
|
|
build: false
|