# Relative paths work OK as long as you start the tool from its local dir
template_path: tool

# This folder gets copied into the output directory
template_static_path: assets

# Templates should have filenames starting in template-
default_template: template-doc.html
default_pdf_template: template-forpdf.html

# HTML, PDF, GFM all get output here
out_path: out

# MD files should be here (and in subdirs)
content_path: content

# This folder gets copied into the output directory
content_static_path: img

# PDF creation needs a dir for temporary files
temporary_files_path: /tmp/

default_filters:
    - multicode_tabs
    - standardize_header_ids
    - buttonize
    - callouts
    - badges
    - link_replacement

callout_class: "devportal-callout"

cover_page:
    name: Home
    html: index.html
    template: template-home.html
    sidebar: disabled

targets:
    # First member is the default that gets built when target not specified
    -   name: local
        display_name: XRP Ledger Dev Portal
        # These github_ fields are used by the template's "Edit on GitHub" link.
        #  Override them with --vars to change which fork/branch to edit.
        github_forkurl: https://github.com/ripple/ripple-dev-portal
        github_branch: master
        recently_updated:
            - html: transaction-common-fields.html
              date: 2018-05-23
            - html: escrowcreate.html
              date: 2018-05-23
            - html: known-amendments.html
              date: 2018-05-23
            - html: technical-faq.html
              date: 2018-05-11

pages:

    -   name: Docs
        funnel: Docs
        template: template-landing-docs.html
        html: docs.html
        sidebar: disabled
        targets:
            - local

# Concepts ---------------------------------------------------------------------

    -   name: Concepts
        funnel: Docs
        doc_type: Concepts
        html: concepts.html
        template: template-landing-children.html
        blurb: Learn the "what" and "why" behind fundamental aspects of the XRP Ledger.
        targets:
            - local

    -   name: Introduction
        funnel: Docs
        doc_type: Concepts
        category: Introduction
        html: introduction.html
        template: template-landing-children.html
        blurb: The XRP Ledger is a decentralized cryptographic ledger powered by a network of peer-to-peer rippled servers. This section covers basic concepts that help you learn the "what" and "why" behind fundamental aspects of the XRP Ledger.
        targets:
            - local

    -   md: concepts/introduction/xrp-ledger-overview.md
        html: xrp-ledger-overview.html
        funnel: Docs
        doc_type: Concepts
        category: Introduction
        blurb: Get a quick and concise introduction to key features of the XRP Ledger.
        targets:
            - local

        #TODO: DOC-1503: replace this with a more concise intro to consensus
    -   md: concepts/introduction/consensus.md
        html: consensus.html
        funnel: Docs
        doc_type: Concepts
        category: Introduction
        blurb: Understand the role of consensus in the XRP Ledger.
        targets:
            - local

    -   md: concepts/introduction/xrp.md
        html: xrp.html
        funnel: Docs
        doc_type: Concepts
        category: Introduction
        blurb: Learn about the uses and properties of XRP, the digital asset for payments.
        targets:
            - local

    -   md: concepts/introduction/technical-faq.md
        html: technical-faq.html
        funnel: Docs
        doc_type: Concepts
        category: Introduction
        blurb: Get answers to frequently asked questions, covering topics such as validators, unique node lists, the role of XRP, and security.
        targets:
            - local

    -   name: Payment System Basics
        html: payment-system-basics.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        template: template-landing-children.html
        blurb: One of the primary purposes of the XRP Ledger is payment processing. Learn more about key concepts that will help you understand the XRP Ledger payment system.
        targets:
            - local

    -   md: concepts/payment-system-basics/accounts/accounts.md
        html: accounts.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        subcategory: Accounts
        blurb: Learn about accounts in the XRP Ledger. Accounts can send transactions and hold XRP.
        targets:
            - local

    -   md: concepts/payment-system-basics/accounts/cryptographic-keys.md
        html: cryptographic-keys.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        subcategory: Accounts
        blurb: Use cryptographic keys to approve transactions so the XRP Ledger can execute them.
        targets:
            - local

    -   md: concepts/payment-system-basics/accounts/multi-signing.md
        html: multi-signing.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        subcategory: Accounts
        blurb: Use multi-signing for greater security sending transactions.
        targets:
            - local

    -   md: concepts/payment-system-basics/accounts/reserves.md
        html: reserves.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        subcategory: Accounts
        blurb: XRP Ledger accounts require a reserve of XRP to reduce spam in ledger data.
        targets:
            - local

    -   md: concepts/payment-system-basics/accounts/depositauth.md
        html: depositauth.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        subcategory: Accounts
        blurb: The DepositAuth setting lets an account block incoming payments by default.
        targets:
            - local

    -   md: concepts/payment-system-basics/fees.md
        html: fees.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        blurb: Learn about the types of fees allowed by the XRP Ledger, including neutral fees (payable to no one) that protect the ledger against abuse, as well as fees that users can collect from each other.
        targets:
            - local

    -   md: concepts/payment-system-basics/ledgers.md
        html: ledgers.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        blurb: The XRP Ledger is composed of a series of individual ledgers, or ledger versions, which rippled keeps in its internal database. Learn about the structure and contents of these ledgers.
        targets:
            - local

    -   md: concepts/payment-system-basics/transaction-basics/transaction-basics.md
        html: transaction-basics.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        subcategory: Transaction Basics
        blurb: Transactions are the only way to change the XRP Ledger. Understand what forms they take and how to use them.
        targets:
            - local

    -   md: concepts/payment-system-basics/transaction-basics/transaction-cost.md
        html: transaction-cost.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        subcategory: Transaction Basics
        blurb: The transaction cost is a small amount of XRP destroyed to send a transaction, which protects the ledger from spam. Learn how the transaction cost applies.
        targets:
            - local

    -   md: concepts/payment-system-basics/transaction-basics/finality-of-results.md
        html: finality-of-results.html
        funnel: Docs
        doc_type: Concepts
        category: Payment System Basics
        subcategory: Transaction Basics
        blurb: Transactions are the only way to change the XRP Ledger. Understand what forms they take and how to use them.
        targets:
            - local

    # TODO: "Source and Destination Tags" stand-alone document

    -   name: Complex Payment Types
        html: complex-payment-types.html
        funnel: Docs
        doc_type: Concepts
        category: Complex Payment Types
        template: template-landing-children.html
        blurb: In addition to simple point-to-point XRP Payments, the XRP Ledger supports a number of complex payment types for a variety of use cases and situations.
        targets:
            - local

    -   md: concepts/complex-payment-types/cross-currency-payments.md
        html: cross-currency-payments.html
        funnel: Docs
        doc_type: Concepts
        category: Complex Payment Types
        blurb: Cross-currency payments atomically deliver a different currency than they send by converting through paths and order books.
        targets:
            - local

    -   md: concepts/complex-payment-types/checks.md
        html: checks.html
        funnel: Docs
        doc_type: Concepts
        category: Complex Payment Types
        blurb: Checks let users create deferred payments that can be canceled or cashed by the intended recipients.
        targets:
            - local

    -   md: concepts/complex-payment-types/escrow.md
        html: escrow.html
        funnel: Docs
        doc_type: Concepts
        category: Complex Payment Types
        blurb: Escrows set aside XRP and deliver it later when certain conditions are met. Escrows can depend on time limits, cryptographic conditions, or both.
        targets:
            - local

    -   md: concepts/complex-payment-types/partial-payments.md
        html: partial-payments.html
        funnel: Docs
        doc_type: Concepts
        category: Complex Payment Types
        blurb: Partial payments subtract fees from the amount sent, delivering a flexible amount. Partial payments are useful for returning unwanted payments without incurring additional costs.
        targets:
            - local

    -   md: concepts/complex-payment-types/payment-channels.md
        html: payment-channels.html
        funnel: Docs
        doc_type: Concepts
        category: Complex Payment Types
        blurb: Payment Channels enable fast, asynchronous XRP payments that can be divided into very small increments and settled later.
        targets:
            - local

    -   name: Issued Currencies
        html: issued-currencies.html
        funnel: Docs
        doc_type: Concepts
        category: Issued Currencies
        template: template-landing-children.html
        blurb: All currencies other than XRP can be represented in the XRP Ledger as issued currencies. Learn more about how issued currencies function in the XRP Ledger.
        targets:
            - local

    -   md: concepts/issued-currencies/issued-currencies-overview.md
        html: issued-currencies-overview.html
        funnel: Docs
        doc_type: Concepts
        category: Issued Currencies
        blurb: Get an overview of issued currencies and their properties in the XRP Ledger.
        targets:
            - local

    -   md: concepts/issued-currencies/trust-lines-and-issuing.md
        html: trust-lines-and-issuing.html
        funnel: Docs
        doc_type: Concepts
        category: Issued Currencies
        blurb: Learn about the properties and rationale of trust lines.
        targets:
            - local

    -   md: concepts/issued-currencies/authorized-trust-lines.md
        html: authorized-trust-lines.html
        funnel: Docs
        doc_type: Concepts
        category: Issued Currencies
        blurb: Learn about authorized trust lines, which enable a currency issuer to limit who can hold its issued (non-XRP) currencies.
        targets:
            - local

    -   md: concepts/issued-currencies/freezes.md
        html: freezes.html
        funnel: Docs
        doc_type: Concepts
        category: Issued Currencies
        blurb: Freezes can suspend trading of issued currencies for compliance purposes.
        targets:
            - local

    -   md: concepts/issued-currencies/rippling.md
        html: rippling.html
        funnel: Docs
        doc_type: Concepts
        category: Issued Currencies
        blurb: Rippling is automatic multi-party net settlement of issued currency balances.
        targets:
            - local

    -   md: concepts/issued-currencies/transfer-fees.md
        html: transfer-fees.html
        funnel: Docs
        doc_type: Concepts
        category: Issued Currencies
        blurb: Currency issuers can charge a fee for transferring their issued currencies.
        targets:
            - local

    -   md: concepts/issued-currencies/issuing-and-operational-addresses.md
        html: issuing-and-operational-addresses.html
        funnel: Docs
        doc_type: Concepts
        category: Issued Currencies
        blurb: Businesses sending transactions on the XRP Ledger automatically should set up separate addresses for different purposes to minimize risk.
        targets:
            - local

    -   md: concepts/issued-currencies/paths.md
        html: paths.html
        funnel: Docs
        doc_type: Concepts
        category: Issued Currencies
        blurb: Payments of issued currencies must traverse paths of connected users and order books.
        targets:
            - local

    -   md: concepts/issued-currencies/demurrage.md
        html: demurrage.html
        funnel: Docs
        doc_type: Concepts
        category: Issued Currencies
        blurb: (Obsolete) Some older XRP Ledger tools used to support currency codes with built-in interest and negative interest rates.
        targets:
            - local

    -   name: Decentralized Exchange
        html: decentralized-exchange.html
        funnel: Docs
        doc_type: Concepts
        category: Decentralized Exchange
        template: template-landing-children.html
        blurb: The XRP Ledger contains a fully-functional exchange where users can trade issued currencies for XRP or each other.
        targets:
            - local

    -   md: concepts/decentralized-exchange/offers.md
        html: offers.html
        funnel: Docs
        doc_type: Concepts
        category: Decentralized Exchange
        blurb: Offers are the XRP Ledger's form of currency trading orders. Understand their lifecycle and properties.
        targets:
            - local

    -   md: concepts/decentralized-exchange/autobridging.md
        html: autobridging.html
        funnel: Docs
        doc_type: Concepts
        category: Decentralized Exchange
        blurb: Autobriding automatically connects order books using XRP as an intermediary when it reduces costs.
        targets:
            - local

    -   md: concepts/decentralized-exchange/ticksize.md
        html: ticksize.html
        funnel: Docs
        doc_type: Concepts
        category: Decentralized Exchange
        blurb: Issuers can set custom tick sizes for currencies to reduce churn in order books over miniscule differences in exchange rates.
        targets:
            - local

    -   name: Consensus Network
        html: consensus-network.html
        funnel: Docs
        doc_type: Concepts
        category: Consensus Network
        template: template-landing-children.html
        blurb: The XRP Ledger uses a consensus algorithm to resolve the double spend problem and choose which transactions to execute in which order. Consensus also governs rules of transaction processing.
        targets:
            - local

    # TODO: validators & UNLs

    -   md: concepts/consensus-network/amendments.md
        html: amendments.html
        funnel: Docs
        doc_type: Concepts
        category: Consensus Network
        blurb: Amendments represent new features or other changes to transaction processing. Validators coordinate through consensus to apply these upgrades to the XRP Ledger in an orderly fashion.
        targets:
            - local

    -   md: concepts/consensus-network/consensus-principles-and-rules.md
        html: consensus-principles-and-rules.html
        funnel: Docs
        doc_type: Concepts
        category: Consensus Network
        blurb: The rules and principles of the consensus algorithm that allow users to transfer funds (including fiat currencies, digital currencies and other forms of value) across national boundaries as seamlessly as sending an email.
        targets:
          - local

    -   md: concepts/consensus-network/fee-voting.md
        html: fee-voting.html
        funnel: Docs
        doc_type: Concepts
        category: Consensus Network
        blurb: How validators vote on fees (transaction cost and reserve requirements).
        targets:
          - local

    -   md: concepts/consensus-network/consensus-research.md
        html: consensus-research.html
        funnel: Docs
        doc_type: Concepts
        category: Consensus Network
        blurb: Scholarly articles on consensus algorithms and related research.
        targets:
          - local

    # TODO: add pseudo-transactions concept page

    -   md: concepts/consensus-network/parallel-networks.md
        html: parallel-networks.html
        funnel: Docs
        doc_type: Concepts
        category: Consensus Network
        blurb: Understand how test networks and alternate ledger chains relate to the production XRP Ledger.
        targets:
          - local

    -   name: The rippled Server
        html: the-rippled-server.html
        funnel: Docs
        doc_type: Concepts
        category: The rippled Server
        template: template-landing-children.html
        blurb: rippled is the core peer-to-peer server that manages the XRP Ledger. This section covers concepts that help you learn the "what" and "why" behind fundamental aspects of the rippled server.
        targets:
            - local

    -   md: concepts/the-rippled-server/rippled-server-modes.md
        html: rippled-server-modes.html
        funnel: Docs
        doc_type: Concepts
        category: The rippled Server
        blurb: Learn about rippled server modes, including stock servers, validator servers, and rippled servers run in stand-alone mode.
        targets:
            - local

    -   md: concepts/the-rippled-server/clustering.md
        html: clustering.html
        funnel: Docs
        doc_type: Concepts
        category: The rippled Server
        blurb: Run rippled servers in a cluster to share the load of cryptography between them.
        targets:
            - local

    -   md: concepts/the-rippled-server/history-sharding.md
        html: history-sharding.html
        funnel: Docs
        doc_type: Concepts
        category: The rippled Server
        blurb: History sharding divides the work of keeping historical ledger data among rippled servers.
        targets:
            - local

    -   md: concepts/the-rippled-server/peer-protocol.md
        html: peer-protocol.html
        funnel: Docs
        doc_type: Concepts
        category: The rippled Server
        blurb: The peer protocol specifies the language rippled servers speak to each other.
        targets:
            - local

# Tutorials --------------------------------------------------------------------

    -   name: Tutorials
        html: tutorials.html
        funnel: Docs
        doc_type: Tutorials
        template: template-landing-children.html
        blurb: Get step-by-step guidance to perform common tasks with the XRP Ledger.
        targets:
            - local

    -   name: Get Started
        html: get-started.html
        funnel: Docs
        doc_type: Tutorials
        category: Get Started
        template: template-landing-children.html
        blurb: Get up and running with some of the resources you'll use to work with the XRP Ledger.
        targets:
            - local

    -   md: tutorials/get-started/get-started-with-the-rippled-api.md
        html: get-started-with-the-rippled-api.html
        funnel: Docs
        doc_type: Tutorials
        category: Get Started
        blurb: Connect to the rippled API and get data about the shared ledger state.
        targets:
            - local

    # TODO: Send a Transaction with the rippled API

    -   md: tutorials/get-started/get-started-with-rippleapi-for-javascript.md
        html: get-started-with-rippleapi-for-javascript.html
        funnel: Docs
        doc_type: Tutorials
        category: Get Started
        blurb: Build an entry-level JavaScript application for querying the XRP Ledger.
        targets:
            - local

    # TODO: Get Started with API Tools

    -   name: Use Simple XRP Payments
        html: use-simple-xrp-payments.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Simple XRP Payments
        template: template-landing-children.html
        blurb: Direct XRP payments from one account to another are the simplest way to transact in the XRP Ledger. This section includes tutorials for how to use simple transactions proficiently and robustly.
        targets:
            - local

    # TODO: "Send XRP"

    -   md: tutorials/use-simple-xrp-payments/reliable-transaction-submission.md
        html: reliable-transaction-submission.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Simple XRP Payments
        blurb: Build a system that can submit transactions to the XRP Ledger and get their final results safely and quickly.
        targets:
            - local

    -   md: tutorials/use-simple-xrp-payments/cancel-or-skip-a-transaction.md
        html: cancel-or-skip-a-transaction.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Simple XRP Payments
        blurb: Replace a pending transaction if it gets stuck from paying too low a transaction cost.
        targets:
          - local

    -   md: tutorials/use-simple-xrp-payments/look-up-transaction-results.md
        html: look-up-transaction-results.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Simple XRP Payments
        blurb: Find the results of previously-submitted transactions.
        targets:
          - local

    -   name: Manage Account Settings
        html: manage-account-settings.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage Account Settings
        template: template-landing-children.html
        blurb: Set up your XRP Ledger account to send and receive payments the way you want it to.
        targets:
            - local

    # TODO: "Get an Account" (DOC-1554)
    # blurb: Learn how to generate and fund an XRP Ledger address to create an XRP Ledger account.

    -   md: tutorials/manage-account-settings/assign-a-regular-key-pair.md
        html: assign-a-regular-key-pair.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage Account Settings
        blurb: Authorize a second key pair to sign transactions from your account. This key pair can be changed or removed later.
        targets:
            - local

    -   md: tutorials/manage-account-settings/change-or-remove-a-regular-key-pair.md
        html: change-or-remove-a-regular-key-pair.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage Account Settings
        blurb: Remove or update a regular key pair already authorized by your account.
        targets:
            - local

    -   md: tutorials/manage-account-settings/set-up-multi-signing.md
        html: set-up-multi-signing.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage Account Settings
        blurb: Add a signer list to your account to enable multi-signing.
        targets:
            - local

    -   md: tutorials/use-simple-xrp-payments/send-a-multi-signed-transaction.md
        html: send-a-multi-signed-transaction.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage Account Settings
        blurb: Send a transaction authorized with multiple signatures.
        targets:
            - local

    # TODO: "Use Deposit Authorization to Block Unwanted Payments" (DOC-1555)

    -   name: Use Complex Payment Types
        html: use-complex-payment-types.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        template: template-landing-children.html
        blurb: Use advanced features like Escrow and Payment Channels to build smart applications on the XRP Ledger.
        targets:
            - local

    -   name: Use Escrows
        html: use-escrows.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Escrows
        blurb: The XRP Ledger supports held payments, or escrows, that can be executed only after a certain time has passed or a cryptographic condition has been fulfilled. Escrows can only send XRP, not issued currencies. You can use these features to build publicly-provable smart contracts. This sections explains basic tasks relating to held payments.
        template: template-landing-children.html
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-escrows/send-a-time-held-escrow.md
        html: send-a-time-held-escrow.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Escrows
        blurb: Create an escrow whose only condition for release is that a specific time has passed.
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-escrows/send-a-conditionally-held-escrow.md
        html: send-a-conditionally-held-escrow.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Escrows
        blurb: Create an escrow whose release is based on a condition being fulfilled.
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-escrows/cancel-an-expired-escrow.md
        html: cancel-an-expired-escrow.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Escrows
        blurb: Cancel an expired escrow.
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-escrows/look-up-escrows.md
        html: look-up-escrows.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Escrows
        blurb: Look up pending escrows by sender or destination address.
        targets:
            - local

    #TODO: split concept info off of the paychan tutorial
    -   md: tutorials/use-complex-payment-types/use-payment-channels.md
        html: use-payment-channels.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        blurb: Payment Channels are an advanced feature for sending "asynchronous" XRP payments that can be divided into very small increments and settled later. This tutorial walks through the entire process of using a payment channel, with examples using the JSON-RPC API of a local rippled server.
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-checks/use-checks.md
        html: use-checks.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Checks
        blurb: Checks in the XRP Ledger authorize another account to claim funds later, similar to how personal paper checks work.
        template: template-landing-children.html
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-checks/send-a-check.md
        html: send-a-check.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Checks
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.md
        html: cash-a-check-for-an-exact-amount.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Checks
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md
        html: cash-a-check-for-a-flexible-amount.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Checks
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-checks/cancel-a-check.md
        html: cancel-a-check.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Checks
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.md
        html: look-up-checks-by-sender.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Checks
        targets:
            - local

    -   md: tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.md
        html: look-up-checks-by-recipient.html
        funnel: Docs
        doc_type: Tutorials
        category: Use Complex Payment Types
        subcategory: Use Checks
        targets:
            - local

    # TODO: "Send a Cross-Currency Payment"

    ## This category commented out until DOC-1562 gets done
    # -   md: tutorials/manage-issued-currencies/manage-issued-currencies.md
    #     html: manage-issued-currencies.html
    #     funnel: Docs
    #     doc_type: Tutorials
    #     category: Manage Issued Currencies
    #     blurb: Use issued currencies for cross-currency payments, trading in the decentralized exchange, or as natively digital tokens.
    #     template: template-landing-children.html
    #     targets:
    #         - local

    # TODO: Set up issuing/operational addresses, monitor changes to balances,
    # freeze, enable/disable rippling, set transfer fees, use auth'd trust lines

    -   name: XRP Ledger Businesses
        html: xrp-ledger-businesses.html
        funnel: Docs
        doc_type: Tutorials
        category: XRP Ledger Businesses
        blurb: This section demonstrates how to follow various best practices for running businesses that interface with the XRP Ledger, such as exchanges listing XRP and gateways issuing currency in the XRP Ledger.
        template: template-landing-children.html
        targets:
            - local

    -   md: tutorials/xrp-ledger-businesses/list-xrp-as-an-exchange.md
        html: list-xrp-as-an-exchange.html
        funnel: Docs
        doc_type: Tutorials
        category: XRP Ledger Businesses
        blurb: Using a fictitious business called Alpha Exchange, this tutorial demonstrates the high-level steps required to list XRP.
        targets:
            - local

    -   md: tutorials/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md
        html: become-an-xrp-ledger-gateway.html
        funnel: Docs
        doc_type: Tutorials
        category: XRP Ledger Businesses
        blurb: Gateways are the businesses that link the XRP Ledger to the rest of the world. This tutorial demonstrates how an existing online financial institution can expand to act as a gateway in the the XRP Ledger.
        targets:
            - local

    # TODO: identify your accounts with ripple.txt (to come later)

    -   name: Manage the rippled Server
        html: manage-the-rippled-server.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage the rippled Server
        blurb: Build, install, and run the rippled server. Configure it to your use case and troubleshoot problems.
        template: template-landing-children.html
        targets:
            - local

    -   md: tutorials/manage-the-rippled-server/capacity-planning.md
        html: capacity-planning.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage the rippled Server
        targets:
            - local

    -   md: tutorials/manage-the-rippled-server/install-rippled.md
        html: install-rippled.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage the rippled Server
        targets:
            - local

    -   md: tutorials/manage-the-rippled-server/update-rippled.md
        html: update-rippled.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage the rippled Server
        targets:
            - local

    -   md: tutorials/manage-the-rippled-server/cluster-rippled-servers.md
        html: cluster-rippled-servers.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage the rippled Server
        targets:
            - local

    -   md: tutorials/manage-the-rippled-server/run-rippled-as-a-validator.md
        html: run-rippled-as-a-validator.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage the rippled Server
        targets:
            - local

    -   md: tutorials/manage-the-rippled-server/start-a-new-genesis-ledger-in-stand-alone-mode.md
        html: start-a-new-genesis-ledger-in-stand-alone-mode.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage the rippled Server
        targets:
            - local

    -   md: tutorials/manage-the-rippled-server/load-a-saved-ledger-in-stand-alone-mode.md
        html: load-a-saved-ledger-in-stand-alone-mode.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage the rippled Server
        targets:
            - local

    -   md: tutorials/manage-the-rippled-server/advance-the-ledger-in-stand-alone-mode.md
        html: advance-the-ledger-in-stand-alone-mode.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage the rippled Server
        targets:
            - local

    -   md: tutorials/manage-the-rippled-server/build-run-rippled-ubuntu.md
        html: build-run-rippled-ubuntu.html
        funnel: Docs
        doc_type: Tutorials
        category: Manage the rippled Server
        targets:
            - local

    # TODO: troubleshoot rippled,
    #  run a validator, run in stand-alone mode, set up private peers

# References -------------------------------------------------------------------

    -   name: References
        funnel: Docs
        doc_type: References
        template: template-landing-references.html
        html: references.html
        sidebar: disabled
        blurb: Look up the ins-and-outs of XRP Ledger APIs, including sample requests and responses.
        targets:
            - local

    # rippled API --------------------------------------------------------------

    -   name: rippled API Reference
        html: rippled-api.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        template: template-landing-children.html
        blurb: Use the rippled API to communicate with a rippled server, the core peer-to-peer server that manages the XRP Ledger.
        targets:
            - local

    -   md: references/rippled-api/api-conventions/api-conventions.md
        html: api-conventions.html
        blurb: Common conventions used across the rippled API.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: API Conventions
        template: template-landing-children.html
        targets:
            - local

    -  md: references/rippled-api/api-conventions/basic-data-types.md
       html: basic-data-types.html
       funnel: Docs
       doc_type: References
       supercategory: rippled API
       category: API Conventions
       targets:
         - local

    -   md: references/rippled-api/api-conventions/currency-formats.md
        html: currency-formats.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: API Conventions
        targets:
            - local

    -  md: references/rippled-api/api-conventions/error-formatting.md
       html: error-formatting.html
       funnel: Docs
       doc_type: References
       supercategory: rippled API
       category: API Conventions
       targets:
         - local

    -  md: references/rippled-api/api-conventions/markers-and-pagination.md
       html: markers-and-pagination.html
       funnel: Docs
       doc_type: References
       supercategory: rippled API
       category: API Conventions
       targets:
         - local

    -  md: references/rippled-api/api-conventions/modifying-the-ledger.md
       html: modifying-the-ledger.html
       funnel: Docs
       doc_type: References
       supercategory: rippled API
       category: API Conventions
       targets:
         - local

    -  md: references/rippled-api/api-conventions/request-formatting.md
       html: request-formatting.html
       funnel: Docs
       doc_type: References
       supercategory: rippled API
       category: API Conventions
       targets:
         - local

    -  md: references/rippled-api/api-conventions/response-formatting.md
       html: response-formatting.html
       funnel: Docs
       doc_type: References
       supercategory: rippled API
       category: API Conventions
       targets:
         - local

    -  md: references/rippled-api/api-conventions/rippled-server-states.md
       html: rippled-server-states.html
       funnel: Docs
       doc_type: References
       supercategory: rippled API
       category: API Conventions
       targets:
         - local

# rippled Public Methods

    -   md: references/rippled-api/public-rippled-methods/public-rippled-methods.md
        html: public-rippled-methods.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        blurb: Get data from the XRP Ledger and submit transactions using these public API methods.
        targets:
            - local

    -   name: Account Methods
        html: account-methods.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Account Methods
        template: template-landing-children.html
        blurb: An account in the XRP Ledger represents a holder of XRP and a sender of transactions. Use these methods to work with account info.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/account-methods/account_channels.md
        html: account_channels.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Account Methods
        blurb: Get a list of payment channels where the account is the source of the channel.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/account-methods/account_currencies.md
        html: account_currencies.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Account Methods
        blurb: Get a list of currencies an account can send or receive.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/account-methods/account_info.md
        html: account_info.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Account Methods
        blurb: Get basic data about an account.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/account-methods/account_lines.md
        html: account_lines.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Account Methods
        blurb: Get info about an account's trust lines.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/account-methods/account_objects.md
        html: account_objects.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Account Methods
        blurb: Get all ledger objects owned by an account.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/account-methods/account_offers.md
        html: account_offers.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Account Methods
        blurb: Get info about an account's currency exchange offers.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/account-methods/account_tx.md
        html: account_tx.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Account Methods
        blurb: Get info about an account's transactions.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/account-methods/gateway_balances.md
        html: gateway_balances.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Account Methods
        blurb: Calculate total amounts issued by an account.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/account-methods/noripple_check.md
        html: noripple_check.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Account Methods
        blurb: Get recommended changes to an account's DefaultRipple and NoRipple settings.
        targets:
            - local

    -   name: Ledger Methods
        html: ledger-methods.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Ledger Methods
        blurb: A ledger version contains a header, a transaction tree, and a state tree, which contain account settings, trustlines, balances, transactions, and other data. Use these methods to retrieve ledger info.
        template: template-landing-children.html
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/ledger-methods/ledger.md
        html: ledger.html # Watch carefully for clashes w/ this filename
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Ledger Methods
        blurb: Get info about a ledger version.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/ledger-methods/ledger_closed.md
        html: ledger_closed.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Ledger Methods
        blurb: Get the latest closed ledger version.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/ledger-methods/ledger_current.md
        html: ledger_current.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Ledger Methods
        blurb: Get the current working ledger version.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/ledger-methods/ledger_data.md
        html: ledger_data.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Ledger Methods
        blurb: Get the raw contents of a ledger version.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/ledger-methods/ledger_entry.md
        html: ledger_entry.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Ledger Methods
        blurb: Get one element from a ledger version.
        targets:
            - local

    -   name: Transaction Methods
        html: transaction-methods.html # watch for clashes w/ this filename
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Transaction Methods
        template: template-landing-children.html
        blurb: Transactions are the only thing that can modify the shared state of the XRP Ledger. All business on the XRP Ledger takes the form of transactions. Use these methods to work with transactions.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/transaction-methods/sign.md
        html: sign.html # watch for clashes w/ this filename
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Transaction Methods
        blurb: Cryptographically sign a transaction.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/transaction-methods/sign_for.md
        html: sign_for.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Transaction Methods
        blurb: Contribute to a multi-signature.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/transaction-methods/submit.md
        html: submit.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Transaction Methods
        blurb: Send a transaction to the network.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/transaction-methods/submit_multisigned.md
        html: submit_multisigned.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Transaction Methods
        blurb: Send a multi-signed transaction to the network.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/transaction-methods/transaction_entry.md
        html: transaction_entry.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Transaction Methods
        blurb: Retrieve info about a transaction from a particular ledger version.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/transaction-methods/tx.md
        html: tx.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Transaction Methods
        blurb: Retrieve info about a transaction from all the ledgers on hand.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/transaction-methods/tx_history.md
        html: tx_history.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Transaction Methods
        blurb: Retrieve info about all recent transactions.
        targets:
            - local

    -   name: Path and Order Book Methods
        html: path-and-order-book-methods.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Path and Order Book Methods
        blurb: Paths define a way for payments to flow through intermediary steps on their way from sender to receiver. Paths enable cross-currency payments by connecting sender and receiver through order books. Use these methods to work with paths and other books.
        template: template-landing-children.html
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md
        html: book_offers.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Path and Order Book Methods
        blurb: Get info about offers to exchange two currencies.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/path-and-order-book-methods/path_find.md
        html: path_find.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Path and Order Book Methods
        blurb: Find a path for a payment between two accounts and receive updates.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/path-and-order-book-methods/ripple_path_find.md
        html: ripple_path_find.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Path and Order Book Methods
        blurb: Find a path for payment between two accounts, once.
        targets:
            - local

    -   name: Payment Channel Methods
        html: payment-channel-methods.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Payment Channel Methods
        blurb: Payment channels are a tool for facilitating repeated, unidirectional payments, or temporary credit between two parties. Use these methods to work with payment channels.
        template: template-landing-children.html
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/payment-channel-methods/channel_authorize.md
        html: channel_authorize.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Payment Channel Methods
        blurb: Sign a claim for money from a payment channel.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/payment-channel-methods/channel_verify.md
        html: channel_verify.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Payment Channel Methods
        blurb: Check a payment channel claim's signature.
        targets:
            - local

    -   name: Subscription Methods
        html: subscription-methods.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Subscription Methods
        blurb: Use these methods to enable the server to push updates to your client when various events happen, so that you can know and react right away. WebSocket API only.
        template: template-landing-children.html
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md
        html: subscribe.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Subscription Methods
        blurb: Listen for updates about a particular subject.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/subscription-methods/unsubscribe.md
        html: unsubscribe.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Subscription Methods
        blurb: Stop listening for updates about a particular subject.
        targets:
            - local

    -   name: Server Info Methods
        html: server-info-methods.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Server Info Methods
        blurb: Use these methods to retrieve information about the current state of the rippled server.
        template: template-landing-children.html
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/server-info-methods/fee.md
        html: fee.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Server Info Methods
        blurb: Get information about transaction cost.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/server-info-methods/server_info.md
        html: server_info.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Server Info Methods
        blurb: Retrieve status of the server in human-readable format.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/server-info-methods/server_state.md
        html: server_state.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Server Info Methods
        blurb: Retrieve status of the server in machine-readable format.
        targets:
            - local

    -   name: Utility Methods
        html: utility-methods.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Utility Methods
        blurb: Use these methods to perform convenient tasks, such as ping and random number generation.
        template: template-landing-children.html
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/utility-methods/json.md
        html: json.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Utility Methods
        blurb: Pass JSON through the commandline.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/utility-methods/ping.md
        html: ping.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Utility Methods
        blurb: Confirm connectivity with the server.
        targets:
            - local

    -   md: references/rippled-api/public-rippled-methods/utility-methods/random.md
        html: random.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Public rippled Methods
        subcategory: Utility Methods
        blurb: Generate a random number.
        targets:
            - local

    -   md: references/rippled-api/admin-rippled-methods/admin-rippled-methods.md
        html: admin-rippled-methods.html
        blurb: Admin methods are meant only for trusted personnel in charge of keeping the server operational. Admin methods include commands for managing, monitoring, and debugging the server.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        blurb: Administer a rippled server with these admin API methods.
        targets:
            - local

    -   name: Key Generation Methods
        html: key-generation-methods.html
        blurb: Use these methods to generate and manage keys.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Key Generation Methods
        template: template-landing-children.html
        targets:
            - local

    -   md: references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md
        html: validation_create.html
        blurb: Generate keys for a new rippled validator.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Key Generation Methods
        targets:
            - local

    -   md: references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md
        html: wallet_propose.html
        blurb: Generate keys for a new account.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Key Generation Methods
        targets:
          - local

    -   name: Logging and Data Management Methods
        html: logging-and-data-management-methods.html
        blurb: Use these methods to manage log levels and other data, such as ledgers.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Logging and Data Management Methods
        template: template-landing-children.html
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md
        html: can_delete.html
        blurb: Allow online deletion of ledgers up to a specific ledger.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Logging and Data Management Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md
        html: ledger_cleaner.html
        blurb: Configure the ledger cleaner service to check for corrupted data.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Logging and Data Management Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md
        html: ledger_request.html
        blurb: Query peer servers for a specific ledger version.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Logging and Data Management Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md
        html: log_level.html
        blurb: Get or modify log verbosity.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Logging and Data Management Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md
        html: logrotate.html
        blurb: Reopen the log file.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Logging and Data Management Methods
        targets:
          - local

    -   name: Server Control Methods
        html: server-control-methods.html
        blurb: Use these methods to manage the rippled server.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Server Control Methods
        template: template-landing-children.html
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/server-control-methods/connect.md
        html: connect.html
        blurb: Force the rippled server to connect to a specific peer.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Server Control Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md
        html: ledger_accept.html
        blurb: Close and advance the ledger in stand-alone mode.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Server Control Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/server-control-methods/stop.md
        html: stop.html
        blurb: Shut down the rippled server.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Server Control Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md
        html: validation_seed.html
        blurb: Temporarily set key to be used for validating.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Server Control Methods
        targets:
          - local

    -   name: Status and Debugging Methods
        html: status-and-debugging-methods.html
        blurb: Use these methods to check the status of the network and server.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Status and Debugging Methods
        template: template-landing-children.html
        targets:
          - local


    -   md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md
        html: consensus_info.html
        blurb: Get information about the state of consensus as it happens.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Status and Debugging Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md
        html: feature.html
        blurb: Get information about protocol amendments.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Status and Debugging Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md
        html: fetch_info.html
        blurb: Get information about the server's sync with the network.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Status and Debugging Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md
        html: get_counts.html
        blurb: Get statistics about the server's internals and memory usage.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Status and Debugging Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md
        html: peers.html
        blurb: Get information about the peer servers connected.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Status and Debugging Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md
        html: print.html
        blurb: Get information about internal subsystems.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Status and Debugging Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md
        html: validator_list_sites.html
        blurb: Get information about sites that publish validator lists.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Status and Debugging Methods
        targets:
          - local

    -   md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md
        html: validators.html
        blurb: Get information about the current validators.
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Admin rippled Methods
        subcategory: Status and Debugging Methods
        targets:
          - local

    -   name: Ledger Data Formats
        html: ledger-data-formats.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        blurb: Learn about individual data objects that comprise the XRP Ledger's shared state.
        template: template-landing-children.html #TODO: consider using the default template instead for page sidebar?
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-header.md
        html: ledger-header.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        blurb: A unique header that describes the contents of a ledger version.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-ids.md
        html: ledger-object-ids.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        blurb: All objects in a ledger's state tree have a unique ID.
        targets:
            - local

    -   name: Ledger Object Types
        html: ledger-object-types.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        template: template-landing-children.html #TODO: consider dropping the md since the page children handles this OK
        blurb: Each ledger's state tree consists of a set of ledger objects, which collectively represent all settings, balances, and relationships in the shared ledger. In the peer protocol that rippled servers use to communicate with each other, ledger objects are represented in their raw binary format. In the rippled API, ledger objects are represented as JSON objects.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md
        html: accountroot.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: The settings, XRP balance, and other metadata for one account.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/amendments.md
        html: amendments-object.html #amendments.html is taken by the concept page
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: Singleton object with status of enabled and pending amendments.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/check.md
        html: check.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: A check that can be redeemed for money by its destination.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/directorynode.md
        html: directorynode.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: Contains links to other objects.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/escrow.md
        html: escrow-object.html #escrow.html is taken by the concept page
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: Contains XRP held for a conditional payment.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/feesettings.md
        html: feesettings.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: Singleton object with consensus-approved base transaction cost and reserve requirements.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/ledgerhashes.md
        html: ledgerhashes.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: Lists of prior ledger versions' hashes for history lookup.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/offer.md
        html: offer.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: An order to make a currency trade.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.md
        html: paychannel.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: A channel for asynchronous XRP payments.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/ripplestate.md
        html: ripplestate.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: Links two accounts, tracking the balance of one currency between them. The concept of a trust line is an abstraction of this object type.
        targets:
            - local

    -   md: references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.md
        html: signerlist.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Ledger Data Formats
        subcategory: Ledger Object Types
        blurb: A list of addresses for multi-signing transactions.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-formats.md
        html: transaction-formats.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        blurb: Transactions are the only way to modify the XRP Ledger. Get details about their required format.
        template: template-landing-children.html
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-common-fields.md
        html: transaction-common-fields.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        blurb: These common fields can be provided on any XRP Ledger transaction.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/transaction-types.md
        html: transaction-types.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: All the different types of transactions that the XRP Ledger can process.
        template: template-landing-children.html
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/accountset.md
        html: accountset.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Set options on an account.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/checkcancel.md
        html: checkcancel.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Cancel a check.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/checkcash.md
        html: checkcash.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Redeem a check.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/checkcreate.md
        html: checkcreate.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Create a check.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/escrowcancel.md
        html: escrowcancel.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Reclaim escrowed XRP.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/escrowcreate.md
        html: escrowcreate.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb:  Create an escrowed XRP payment.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/escrowfinish.md
        html: escrowfinish.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Deliver escrowed XRP to recipient.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/offercancel.md
        html: offercancel.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Withdraw a currency-exchange order.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/offercreate.md
        html: offercreate.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Submit an order to exchange currency.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/payment.md
        html: payment.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Send funds from one account to another.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.md
        html: paymentchannelclaim.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Claim money from a payment channel.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.md
        html: paymentchannelcreate.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Open a new payment channel.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.md
        html: paymentchannelfund.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Add more XRP to a payment channel.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/setregularkey.md
        html: setregularkey.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Add, remove, or modify an account's regular key pair.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/signerlistset.md
        html: signerlistset.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Add, remove, or modify an account's multi-signing list.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-types/trustset.md
        html: trustset.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Types
        blurb: Add or modify a trust line.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/pseudo-transaction-types/pseudo-transaction-types.md
        html: pseudo-transaction-types.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Pseudo-Transaction Types
        blurb: Formats of pseudo-transactions that validators sometimes apply to the XRP Ledger.
        template: template-landing-children.html
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/pseudo-transaction-types/enableamendment.md
        html: enableamendment.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Pseudo-Transaction Types
        blurb: Enable a change in transaction processing.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/pseudo-transaction-types/setfee.md
        html: setfee.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Pseudo-Transaction Types
        blurb: Change global reserve and transaction cost settings.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-results/transaction-results.md
        html: transaction-results.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Results
        blurb: Learn how to interpret rippled server transaction results.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-results/tec-codes.md
        html: tec-codes.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Results
        blurb: tec codes indicate that the transaction failed, but it was applied to a ledger to deduct the transaction cost.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-results/tef-codes.md
        html: tef-codes.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Results
        blurb: tef codes indicate that the transaction failed and was not included in a ledger, but the transaction could have succeeded in some theoretical ledger.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-results/tel-codes.md
        html: tel-codes.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Results
        blurb: tel codes indicate an error in the local server processing the transaction.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-results/tem-codes.md
        html: tem-codes.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Results
        blurb: tem codes indicate that the transaction was malformed, and cannot succeed according to the XRP Ledger protocol.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-results/ter-codes.md
        html: ter-codes.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Results
        blurb: ter codes indicate that the transaction failed, but it could apply successfully in the future, usually if some other hypothetical transaction applies first.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-results/tes-success.md
        html: tes-success.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        subcategory: Transaction Results
        blurb: tesSUCCESS is the only code that indicates a transaction succeeded. This does not always mean it accomplished what you expected it to do.
        targets:
            - local

    -   md: references/rippled-api/transaction-formats/transaction-metadata.md
        html: transaction-metadata.html
        funnel: Docs
        doc_type: References
        supercategory: rippled API
        category: Transaction Formats
        blurb: Transaction metadata describes the outcome of the transaction in detail, regardless of whether the transaction is successful.
        targets:
            - local

    # --------------- end "rippled API" section --------------------------------

    -   name: RippleAPI Reference # name is required for remote-sourced files
        md: https://raw.githubusercontent.com/ripple/ripple-lib/0.22.0/docs/index.md
        html: rippleapi-reference.html
        funnel: Docs
        doc_type: References
        category: RippleAPI for JavaScript
        blurb: Official client library to the XRP Ledger. Available for JavaScript only.
        curated_anchors:
            - name: Transactions
              anchor: "#transaction-overview"
            - name: Basic Types
              anchor: "#basic-types"
            - name: Methods
              anchor: "#api-methods"
        filters:
            - remove_doctoc
            - add_version
        targets:
            - local

    -   md: references/data-api.md
        html: data-api.html
        funnel: Docs
        doc_type: References
        category: Data API
        blurb: Access more XRP Ledger data, including transaction history and analytics.
        curated_anchors:
            - name: Methods
              anchor: "#api-method-reference"
            - name: API Conventions
              anchor: "#api-conventions"
        targets:
            - local


# --------------- end "Docs" section -------------------------------------------
# Use Cases --------------------------------------------------------------------
    -   md: use-cases/use-cases.md
        html: use-cases.html
        funnel: Use Cases
        filters:
            - buttonize
        targets:
            - local

    -   md: use-cases/run-a-rippled-validator.md
        html: run-a-rippled-validator.html
        funnel: Use Cases
        template: template-use-case.html
        useful_background:
            - amendments.html
            - the-rippled-server.html #TODO - add to useful_background when available: fee voting, consensus principles & rules
        targets:
            - local

    -   md: use-cases/list-xrp-in-your-exchange.md
        html: list-xrp-in-your-exchange.html
        funnel: Use Cases
        template: template-use-case.html
        useful_background:
            - xrp-ledger-overview.html
            - reliable-transaction-submission.html
            - xrp.html
        targets:
            - local

    -   md: use-cases/contribute-code-to-rippled.md
        html: contribute-code-to-rippled.html
        funnel: Use Cases
        template: template-use-case.html
        useful_background:
            - consensus.html
            - amendments.html #TODO add to useful_background: stand-alone mode, rippled.cfg reference (future feature)
        targets:
            - local


# Dev Tools --------------------------------------------------------------------
    -   md: dev-tools/dev-tools.md
        funnel: Dev Tools
        filters:
            - buttonize
        targets:
            - local

    -   name: RPC Tool
        funnel: Dev Tools
        html: xrp-ledger-rpc-tool.html
        targets:
            - local
        template: template-xrp-ledger-rpc-tool.html

    -   name: WebSocket API Tool
        funnel: Dev Tools
        template: template-websocket-api-tool.html
        html: websocket-api-tool.html
        targets:
            - local

    -   name: Data API v2 Tool
        funnel: Dev Tools
        html: data-api-v2-tool.html
        methods_js: js/apitool-methods-data_v2.js
        rest_host: https://data.ripple.com
        doc_page: data-api.html
        sidebar: custom
        targets:
            - local
        template: template-rest-api-tool.html

    -   name: ripple.txt Validator
        funnel: Dev Tools
        html: ripple-txt-validator.html
        targets:
            - local
        template: template-ripple-txt-validator.html

    -   name: XRP Test Net Faucet
        funnel: Dev Tools
        html: xrp-test-net-faucet.html
        targets:
            - local
        template: template-test-net.html

# News -------------------------------------------------------------------------

    -   md: news/news.md
        html: news.html
        funnel: News
        targets:
            - local

    -   md: news/known-amendments.md
        html: known-amendments.html
        funnel: News
        targets:
            - local

    # Note: other "News" links (Release Notes, eventually Network Status)
    #  are external to this site

# Special sitemap file (for better Google indexing)
    -   name: Sitemap
        html: sitemap.txt
        template: template-sitemap.txt
        targets:
            - local


ignore_anchors_in:
    - data-api-v2-tool.html
    - websocket-api-tool.html

#Sometimes, a link is not really problematic, but the link checker detects it
# as such and the easiest solution is to ignore it.
known_broken_links:
    # These PDFs download OK in a browser
    - http://eur-lex.europa.eu/legal-content/EN/ALL/?uri=CELEX%3A32015R0847
    - http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2006:345:0001:0009:EN:PDF

# Style Checker Config ------------------------------------------------------ #

word_substitutions_file: tool/word_substitutions.yaml
phrase_substitutions_file: tool/phrase_substitutions.yaml
