bitcoinafterlife/bal-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Upload files to "/"
All checks were successful
Build and deploy docs / deploy (push) Successful in 2s
Details

Browse Source 
added footer link and gitea backup link
This commit is contained in:
bitcoinafterlife
2026-08-30 22:00:19 +00:00
parent dc7edf610d
commit 8fe4211ded
1 changed files with 137 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

273
mkdocs.yml
View File

@@ -1,136 +1,137 @@
site_name: Bitcoin After Life — Manual site_name: Bitcoin After Life — Manual
site_description: Manual for the Bitcoin After Life (BAL) Electrum plugin and the Will-Executor network site_description: Manual for the Bitcoin After Life (BAL) Electrum plugin and the Will-Executor network
site_url: https://bitcoin-after.life/docs/ site_url: https://bitcoin-after.life/docs/
use_directory_urls: false use_directory_urls: false
repo_url: https://bitcoin-after.life/gitea/bitcoinafterlife/bal-docs repo_url: https://bitcoin-after.life/gitea/bitcoinafterlife/bal-docs
repo_name: Gitea repo_name: Gitea
edit_uri: _edit/main/docs/ edit_uri: _edit/main/docs/
theme: theme:
name: material name: material
# Brand assets — see internal/brand-assets.md for where the official files live. # Brand assets — see internal/brand-assets.md for where the official files live.
logo: assets/logo.svg logo: assets/logo.svg
favicon: assets/favicon.png favicon: assets/favicon.png
palette: palette:
- media: "(prefers-color-scheme: light)" - media: "(prefers-color-scheme: light)"
scheme: default scheme: default
primary: custom primary: custom
accent: custom accent: custom
toggle: { icon: material/weather-night, name: Switch to dark mode } toggle: { icon: material/weather-night, name: Switch to dark mode }
- media: "(prefers-color-scheme: dark)" - media: "(prefers-color-scheme: dark)"
scheme: slate scheme: slate
primary: custom primary: custom
accent: custom accent: custom
toggle: { icon: material/weather-sunny, name: Switch to light mode } toggle: { icon: material/weather-sunny, name: Switch to light mode }
font: font:
text: Inter text: Inter
code: Roboto Mono code: Roboto Mono
features: features:
- navigation.sections - navigation.sections
- navigation.top - navigation.top
- navigation.footer - navigation.footer
- navigation.indexes - navigation.indexes
- search.suggest - search.suggest
- content.action.edit - content.action.edit
- content.code.copy - content.code.copy
extra_css: extra_css:
# The ?v= suffix defeats browser caching of the stylesheet. Bump the number # The ?v= suffix defeats browser caching of the stylesheet. Bump the number
# whenever you change extra.css and the browser keeps showing the old style. # whenever you change extra.css and the browser keeps showing the old style.
- stylesheets/extra.css?v=17 - stylesheets/extra.css?v=17
extra_javascript: extra_javascript:
- javascripts/brand-notranslate.js # keep "Bitcoin After Life" untranslated in Chrome - javascripts/brand-notranslate.js # keep "Bitcoin After Life" untranslated in Chrome
- javascripts/nav-section-icons.js # small Material icon before each nav section title - javascripts/nav-section-icons.js # small Material icon before each nav section title
- javascripts/footer-home-link.js # visible "bitcoin-after.life" text link in the footer
nav:
- Home: index.md nav:
- FAQ: faq.md - Home: index.md
- Getting started: - FAQ: faq.md
- Installation: getting-started/installation.md - Getting started:
- Create your first will: getting-started/quick-start.md - Installation: getting-started/installation.md
- User guide: - Create your first will: getting-started/quick-start.md
- Heirs and shares: user-guide/heirs.md - User guide:
- Delivery time: user-guide/delivery-time.md - Heirs and shares: user-guide/heirs.md
- Check Alive: user-guide/check-alive.md - Delivery time: user-guide/delivery-time.md
- The WILL tab: user-guide/will-tab.md - Check Alive: user-guide/check-alive.md
- Keeping the will up to date: user-guide/updating.md - The WILL tab: user-guide/will-tab.md
- Offline backup transaction: user-guide/backup-transaction.md - Keeping the will up to date: user-guide/updating.md
- Wallet recovery use case (or wallet backup): user-guide/wallet-recovery.md - Offline backup transaction: user-guide/backup-transaction.md
- Backing up wallet and will: user-guide/wallet-backup.md - Wallet recovery use case (or wallet backup): user-guide/wallet-recovery.md
- Hardware wallets: user-guide/hardware-wallets.md - Backing up wallet and will: user-guide/wallet-backup.md
- Compatibility: user-guide/compatibility.md - Hardware wallets: user-guide/hardware-wallets.md
- Will-Executors: - Compatibility: user-guide/compatibility.md
- What they are: will-executors/what-they-are.md - Will-Executors:
- Choosing them in the plugin: will-executors/choosing.md - What they are: will-executors/what-they-are.md
- The WeList directory: will-executors/welist.md - Choosing them in the plugin: will-executors/choosing.md
- Running a Will-Executor: will-executors/running-a-server.md - The WeList directory: will-executors/welist.md
- Protocol: - Running a Will-Executor: will-executors/running-a-server.md
- How it works: protocol/how-it-works.md - Protocol:
- Example inheritance plan: examples.md - How it works: protocol/how-it-works.md
- How BAL compares: comparison.md - Example inheritance plan: examples.md
- Security & Privacy: security-privacy.md - How BAL compares: comparison.md
- Press & Media Kit: press-kit.md - Security & Privacy: security-privacy.md
- Press & Media Kit: press-kit.md
plugins:
- search plugins:
- glightbox: # click-to-enlarge on every image (screenshots + diagrams) - search
touchNavigation: true - glightbox: # click-to-enlarge on every image (screenshots + diagrams)
loop: false touchNavigation: true
zoomable: true loop: false
draggable: true zoomable: true
skip_classes: draggable: true
- no-lightbox skip_classes:
- macros: - no-lightbox
on_error_fail: true # a typo in a variable breaks the build, not the page - macros:
on_error_fail: true # a typo in a variable breaks the build, not the page
markdown_extensions:
- admonition markdown_extensions:
- attr_list - admonition
- md_in_html - attr_list
- tables - md_in_html
- footnotes - tables
- pymdownx.details - footnotes
- pymdownx.superfences - pymdownx.details
- pymdownx.tabbed: { alternate_style: true } - pymdownx.superfences
- pymdownx.emoji: - pymdownx.tabbed: { alternate_style: true }
emoji_index: !!python/name:material.extensions.emoji.twemoji - pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg emoji_index: !!python/name:material.extensions.emoji.twemoji
- toc: { permalink: true } emoji_generator: !!python/name:material.extensions.emoji.to_svg
- toc: { permalink: true }
# --- Italian translation (not enabled yet) ------------------------------------
# To add Italian: pip install mkdocs-static-i18n then uncomment: # --- Italian translation (not enabled yet) ------------------------------------
# plugins: # To add Italian: pip install mkdocs-static-i18n then uncomment:
# - search # plugins:
# - i18n: # - search
# docs_structure: suffix # index.md (EN) + index.it.md (IT) # - i18n:
# languages: # docs_structure: suffix # index.md (EN) + index.it.md (IT)
# - locale: en # languages:
# default: true # - locale: en
# name: English # default: true
# - locale: it # name: English
# name: Italiano # - locale: it
# Create it.md siblings only for the pages you have translated; untranslated # name: Italiano
# pages automatically fall back to English. # Create it.md siblings only for the pages you have translated; untranslated
# ------------------------------------------------------------------------------ # pages automatically fall back to English.
# ------------------------------------------------------------------------------
# =============================================================================
# SINGLE SOURCE OF TRUTH FOR VERSIONS # =============================================================================
# Change a value here and it updates everywhere in the manual. # SINGLE SOURCE OF TRUTH FOR VERSIONS
# Used in pages as {{ bal.plugin_version }} etc. # Change a value here and it updates everywhere in the manual.
# ============================================================================= # Used in pages as {{ bal.plugin_version }} etc.
extra: # =============================================================================
bal: extra:
plugin_version: "0.6.1" # latest plugin release bal:
electrum_tested: "4.8.0" # Electrum version v0.6.1 was tested against plugin_version: "0.6.1" # latest plugin release
electrum_latest: "4.8.0" # latest stable Electrum the manual assumes electrum_tested: "4.8.0" # Electrum version v0.6.1 was tested against
welist_fee_sats: "50,000" # WeList yearly listing fee electrum_latest: "4.8.0" # latest stable Electrum the manual assumes
welist_period_days: "365" welist_fee_sats: "50,000" # WeList yearly listing fee
last_reviewed: "2026-07" # bump when you do a full pass over the manual welist_period_days: "365"
social: last_reviewed: "2026-07" # bump when you do a full pass over the manual
- icon: material/web social:
link: https://bitcoin-after.life - icon: material/web
- icon: material/source-repository link: https://bitcoin-after.life
link: https://bitcoin-after.life/gitea/bitcoinafterlife - icon: material/source-repository
link: https://bitcoin-after.life/gitea/bitcoinafterlife
copyright: Bitcoin After Life Protocol — open source. The whole project is built to run on Bitcoin only, with no fiat currency involved anywhere in its design.
copyright: Bitcoin After Life Protocol — open source. The whole project is built to run on Bitcoin only, with no fiat currency involved anywhere in its design.