xrpl-dev-portal/redocly.yaml

ignore:
  - docs/references/http-websocket-apis/admin-api-methods/_template-admin-method.md
  - docs/img/_sources/*
  - _code-samples/*/README.md
  - _code-samples/**/README.md
  - _code-samples/create-amm/ts/tsconfig.json
  - resources/contribute-blog/_blog-template.md
  - resources/contribute-documentation/_tutorial-template.md
l10n:
  defaultLocale: en-US
  locales:
    - code: en-US
      name: English
    - code: ja
      name: 日本語
redirects:
  $ref: redirects.yaml
  /ja/XRPL_Brand_Kit.zip:
    to: /XRPL_Brand_Kit.zip
responseHeaders:
  '**':
    - name: X-Frame-Options
      value: DENY
    - name: Content-Security-Policy
      value: frame-ancestors 'none'
  '/@l10n/es-ES/**':
    - name: X-Robots-Tag
      value: noindex
search:
  engine: typesense
  filters:
    hide: true
aiAssistant:
  hide: false
mcp:
  hide: false
  docs:
    hide: false
    name: "xrpl.org MCP server"
    ignore:
      - ja/**
      - es-es/**
metadataGlobs:
  'docs/**':
    redocly_category: Documentation
  'blog/**':
    redocly_category: Blog
  'resources/**':
    redocly_category: Resources
  'community/**':
    redocly_category: Community
seo:
  siteUrl: https://xrpl.org/
  llmstxt:
    hide: false
    title: XRPL Developer Portal & Documentation
    description: >-
      Explore XRP Ledger documentation, blogs, and other blockchain
      developer resources needed to start building and integrating with the ledger.
    details:
      content: >-
        XRP Ledger concepts, use cases, tutorials, references, and other blockchain
        developer resources. Also, stay up to date with release announcements
        and more through the XRPL Blog.
    sections:
      - title: Introduction
        description: A high-level introduction to the XRP Ledger.
        includeFiles:
          - docs/introduction/**/*.*
          - about/faq.md
        excludeFiles:
          - docs/introduction/index.md
      - title: Use Cases
        description: Real-world applications and business scenarios for the XRP Ledger.
        includeFiles:
          - docs/use-cases/**/*.*
        excludeFiles:
          - docs/use-cases/index.md
          - docs/use-cases/defi/index.md
      - title: Concepts
        description: Core concepts including accounts, tokens, transactions, consensus, and more.
        includeFiles:
          - docs/concepts/**/*.*
        excludeFiles:
          - docs/concepts/index.md
          - docs/concepts/decentralized-storage/index.md
          - docs/concepts/payment-types/index.md
      - title: Tutorials
        description: Step-by-step guides for building on the XRP Ledger in JavaScript, Python, Go, and more.
        includeFiles:
          - docs/tutorials/**/*.*
      - title: References
        description: Protocol specification, transaction types, ledger entries, and API methods.
        includeFiles:
          - docs/references/**/*.*
        excludeFiles:
          - docs/references/xrp-api.md
          - docs/references/data-api.md
          - docs/references/protocol/index.md
          - docs/references/protocol/ledger-data/ledger-entry-types/index.md
          - docs/references/protocol/transactions/index.md
          - docs/references/protocol/transactions/types/index.md
          - docs/references/http-websocket-apis/api-conventions/index.md
          - docs/references/http-websocket-apis/public-api-methods/*/index.md
          - docs/references/http-websocket-apis/admin-api-methods/*/index.md
      - title: Infrastructure
        description: Install, configure, and troubleshoot rippled and Clio servers.
        includeFiles:
          - docs/infrastructure/**/*.*
        excludeFiles:
          - docs/infrastructure/index.md
          - docs/infrastructure/*/index.md
          - docs/infrastructure/installation/build-run-rippled-in-reporting-mode.md
          - docs/infrastructure/configuration/data-retention/index.md
          - docs/infrastructure/configuration/server-modes/index.md
      - title: Blog (2023+)
        description: Recent XRPL Blog posts (showing 2023 and newer).
        includeFiles:
          - blog/2023/**/*.*
          - blog/2024/**/*.*
          - blog/2025/**/*.*
          - blog/2026/**/*.*
      - title: Resources
        description: Developer resources and contribution guidelines.
        includeFiles:
          - resources/**/*.*
        excludeFiles:
          - resources/index.md
analytics:
  gtm:
    includeInDevelopment: true
    trackingId: GTM-KCQZ3L8
    defaultDataLayer:
      platform: redocly
    enableWebVitalsTracking: true
scripts:
  head:
    - src: https://cmp.osano.com/AzyjT6TIZMlgyLyy8/f11f7772-8ed5-4b73-bd17-c0814edcc440/osano.js
    - src: ./static/js/xrpl-2.11.0.min.js
    - src: ./static/vendor/jquery-3.7.1.min.js
    - src: ./static/vendor/bootstrap.min.js
    - src: ./static/js/osano.js
      type: text/javascript
links:
  - href: https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700&display=swap
    rel: stylesheet
  - href: https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400,600,700&display=swap
    rel: stylesheet
  - href: https://fonts.googleapis.com/css?family=Space+Grotesk:300,400,600,700&display=swap
    rel: stylesheet
  - href: ./static/css/devportal2024-v1.css
    rel: stylesheet
  - href: ./static/css/font-awesome.min.css
    rel: stylesheet

logo:
  srcSet: ./static/img/XRPLedger_DevPortal-black.svg light ./static/img/XRPLedger_DevPortal-white.svg dark
  altText: XRP Ledger Developer Portal
  link: /
navbar:
  items:
    $ref: top-nav.yaml
markdown:
  partialsFolders: ["docs/_snippets", "_code-samples", "_api-examples"]
  editPage:
    baseUrl: https://github.com/XRPLF/xrpl-dev-portal/tree/master/
    hide: false
footer:
  logo:
    hide: true
  copyrightText: © 2025 XRP Ledger. Open Source.
  items:
    - group: About
      groupTranslationKey: footer.about
      items:
        - page: about/index.page.tsx
          label: XRPL Overview
          labelTranslationKey: footer.about.xrpl-overview
        - label: Use Cases & Projects
          page: about/uses.page.tsx
          labelTranslationKey: footer.about.use-cases-projects
        - page: about/history.page.tsx
          label: History
          labelTranslationKey: footer.about.history
        - page: about/impact.page.tsx
          label: Impact
          labelTranslationKey: footer.about.impact
        - label: XRPL Foundation
          labelTranslationKey: footer.about.xrpl-foundation
          href: https://xrpl.foundation
          external: true
        - page: about/faq.md
          label: FAQ
          labelTranslationKey: footer.about.faq
        - page: about/privacy-policy.md
          label: Privacy Policy
          labelTranslationKey: footer.about.privacy-policy
    - group: Docs
      groupTranslationKey: footer.docs
      items:
        - label: XRPL Documentation
          page: docs/index.page.tsx
          labelTranslationKey: footer.docs.xrpl-documentation
        - page: docs/introduction/index.md
          label: Introduction
          labelTranslationKey: footer.docs.introduction
        - page: docs/use-cases/index.md
          label: Use Cases
          labelTranslationKey: footer.docs.use-cases
        - page: docs/concepts/index.md
          label: Concepts
          labelTranslationKey: footer.docs.concepts
        - page: docs/tutorials/index.page.tsx
          label: Tutorials
          labelTranslationKey: footer.docs.tutorials
        - page: docs/references/index.md
          label: References
          labelTranslationKey: footer.docs.references
        - page: docs/infrastructure/index.md
          label: Infrastructure
          labelTranslationKey: footer.docs.infrastructure
    - group: Resources
      groupTranslationKey: footer.resources
      items:
        - page: resources/code-samples.page.tsx
          label: Code Samples
          labelTranslationKey: footer.resources.code-samples
        - page: resources/dev-tools/index.page.tsx
          label: Dev Tools
          labelTranslationKey: footer.resources.dev-tools
        - label: XRPL Learning Portal
          labelTranslationKey: footer.resources.xrpl-learning-portal
          href: https://learn.xrpl.org/
          external: true
        - label: XRPL Brand Kit
          labelTranslationKey: footer.resources.xrpl-brand-kit
          href: /XRPL_Brand_Kit.zip
          external: true
        - label: Ledger Explorer
          labelTranslationKey: footer.resources.explorer
          href: https://livenet.xrpl.org/
          external: true
        - page: resources/known-amendments.md
          label: Known Amendments
          labelTranslationKey: footer.resources.known-amendments
        - page: resources/contribute-code/index.md
          label: Contribute Code
          labelTranslationKey: footer.resources.contribute-code
        - page: resources/contribute-documentation/index.md
          label: Contribute Documentation
          labelTranslationKey: footer.resources.contribute-documentation
    - group: Community
      groupTranslationKey: footer.community
      items:
        - page: community/index.page.tsx
          label: Community
          labelTranslationKey: footer.community.community
        - page: community/events.page.tsx
          label: Events
          labelTranslationKey: footer.community.events
        - page: community/ambassadors.page.tsx
          label: Ambassadors
          labelTranslationKey: footer.community.ambassadors
        - page: community/developer-funding.page.tsx
          label: Developer Funding
          labelTranslationKey: footer.community.developer-funding
        - label: XRPL Jobs
          labelTranslationKey: footer.community.xrpl-jobs
          href: https://jobs.xrpl.org/
          external: true
        - page: blog/index.page.tsx
          label: XRP Ledger Community Blog
          labelTranslationKey: footer.community.dev-blog
        - label: XRPL Grants
          labelTranslationKey: footer.community.xrpl-grants
          href: https://xrplgrants.org/
          external: true
        - label: GitHub
          labelTranslationKey: footer.community.github
          href: https://github.com/XRPLF/
          external: true
        - page: community/report-a-scam.md
          label: Report a Scam
          labelTranslationKey: footer.community.report-a-scam