diff --git a/5layers.yml b/5layers.yml new file mode 100644 index 0000000000..28c75a991b --- /dev/null +++ b/5layers.yml @@ -0,0 +1,219 @@ +# 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: Overview + html: index.html + template: template-5layerindex.html + +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 + +pages: + + - name: Docs + funnel: Docs + template: template-landing-docs.html + html: landing-docs.html + targets: + - local + + - name: Concepts + funnel: Docs + doc_type: Concepts + html: landing-concepts.html + targets: + - local + + - name: Payment System + funnel: Docs + doc_type: Concepts + category: Payment System + html: concept-payment-system.html + template: template-cat-landing.html + targets: + - local + + - md: concept-accounts.md + funnel: Docs + doc_type: Concepts + category: Payment System + subcategory: Accounts + targets: + - local + + - md: concept-depositauth.md + funnel: Docs + doc_type: Concepts + category: Payment System + subcategory: Accounts + targets: + - local + + - md: concept-transaction-cost.md + funnel: Docs + doc_type: Concepts + category: Payment System + targets: + - local + + - md: concept-money.md + funnel: Docs + doc_type: Concepts + category: Payment System + targets: + - local + + - name: Consensus Network + funnel: Docs + doc_type: Concepts + category: Consensus Network + html: concept-consensus-network.html + template: template-cat-landing.html + targets: + - local + + - name: References + funnel: Docs + doc_type: References + html: landing-references.html + targets: + - local + + - name: rippled API Public Methods + funnel: Docs + doc_type: References + category: rippled API Public Methods + html: reference-rippled-public.html + template: template-cat-landing.html + targets: + - local + + - name: Ledger Methods + funnel: Docs + doc_type: References + category: rippled API Public Methods + subcategory: Ledger Methods + template: template-subcat-landing.html + html: reference-rippled-public-ledger-methods.html + targets: + - local + + - md: rippled-api-methods/ledger_closed.md + funnel: Docs + doc_type: References + category: rippled API Public Methods + subcategory: Ledger Methods + targets: + - local + + - md: rippled-api-methods/ledger_current.md + funnel: Docs + doc_type: References + category: rippled API Public Methods + subcategory: Ledger Methods + targets: + - local + + - md: rippled-api-methods/ledger_data.md + funnel: Docs + doc_type: References + category: rippled API Public Methods + subcategory: Ledger Methods + targets: + - local + + - name: Account Methods + funnel: Docs + doc_type: References + category: rippled API Public Methods + subcategory: Account Methods + template: template-subcat-landing.html + html: reference-rippled-public-account-methods.html + targets: + - local + + - md: rippled-api-methods/account_channels.md + funnel: Docs + doc_type: References + category: rippled API Public Methods + subcategory: Account Methods + targets: + - local + + - md: rippled-api-methods/account_info.md + funnel: Docs + doc_type: References + category: rippled API Public Methods + subcategory: Account Methods + targets: + - local + + - name: Transaction Methods + funnel: Docs + doc_type: References + category: rippled API Public Methods + subcategory: Transaction Methods + template: template-subcat-landing.html + html: reference-rippled-public-tx-methods.html + targets: + - local + + +ignore_anchors_in: + - data-api-v2-tool.html + - ripple-api-tool.html + - tool-jsonrpc.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: + # Strangely, Python doesn't like the cert here. Firefox is OK with it. + - https://validators.ripple.com + + # Login required for the client portal. + - https://clients.ripple.com/ + + # 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 diff --git a/assets/css/devportal.css b/assets/css/devportal.css index 1cf2acee8d..0342e4ece1 100644 --- a/assets/css/devportal.css +++ b/assets/css/devportal.css @@ -863,3 +863,15 @@ th { overflow: visible !important; } } + +/******************************************************************************* +* New stuff for 5-level nesting +*******************************************************************************/ + +.subcategory_title { + font-weight: bold; +} + +#sidenav_accordion .panel .sidebar_cat_pagelist li .subpage { + padding-left: 75px; +} diff --git a/content/concept-accounts.md b/content/concept-accounts.md index a4980d48bf..a667787144 100644 --- a/content/concept-accounts.md +++ b/content/concept-accounts.md @@ -1,4 +1,4 @@ -# XRP Ledger Accounts +# Accounts An "Account" in the XRP Ledger represents a holder of XRP and a sender of [transactions](reference-transaction-format.html). The core elements of an account are: diff --git a/tool/template-5layerindex.html b/tool/template-5layerindex.html new file mode 100644 index 0000000000..5a63aebafc --- /dev/null +++ b/tool/template-5layerindex.html @@ -0,0 +1,58 @@ +{% extends "template-base.html" %} +{% block head %} + + + + + +{% endblock %} + +{% block bodyclasses %}xrp-ledger-dev-portal no-sidebar{% endblock %} + +{% block breadcrumbs %}{% endblock %} + +{% block main %} +
+

All Pages

+
+
+
+
+
+ + + + +
+

+ These resources are provided for informational purposes only, as illustrative references for your independent development of products or services designed to interface with Ripple’s open-source technologies. These resources are not intended to direct or influence how you or any other person interacts with Ripple’s open-source technologies. Ripple does not endorse any specific resource and makes no representations or warranties with respect to the resources listed. +

+

+ Note that anti-money laundering and counter-terrorism financing laws and regulations, such as the U.S. Bank Secrecy Act and regulations issued by the Financial Crimes Enforcement Network (FinCEN), require certain parties to take certain precautions against financial crime. In particular, you may be interested in the 2013 guidance issued by FinCEN in response to questions concerning the regulatory treatment of persons who use or make a business of exchanging, accepting, or transmitting certain virtual currencies. Additional FinCEN references are available at https://www.fincen.gov. +

+
+ +{% endblock %} diff --git a/tool/template-base.html b/tool/template-base.html index 686c2f17dc..cde5dfaa83 100644 --- a/tool/template-base.html +++ b/tool/template-base.html @@ -46,9 +46,18 @@ {% block breadcrumbs %} {% endblock %} diff --git a/tool/template-cat-landing.html b/tool/template-cat-landing.html new file mode 100644 index 0000000000..269e9486bb --- /dev/null +++ b/tool/template-cat-landing.html @@ -0,0 +1,25 @@ +{% extends "template-base.html" %} + +{% block sidebar %} +{% if currentpage.sidebar != "disabled" %} + + {% include "template-sidebar_nav.html" %} + +{% endif %} +{% endblock %} + +{% block main %} +

{{ currentpage.name }}

+ +
+

Pages in this category:

+ +
+{% endblock %} diff --git a/tool/template-landing-docs.html b/tool/template-landing-docs.html new file mode 100644 index 0000000000..7ed701e3f6 --- /dev/null +++ b/tool/template-landing-docs.html @@ -0,0 +1,22 @@ +{% extends "template-base.html" %} + +{% block sidebar %} +{% if currentpage.sidebar != "disabled" %} + + {% include "template-sidebar_nav.html" %} + +{% endif %} +{% endblock %} + +{% block main %} +

{{ currentpage.name }}

+ +
+
+ Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. +
+
+ Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. +
+
+{% endblock %} diff --git a/tool/template-sidebar_nav.html b/tool/template-sidebar_nav.html index 8bfc1abcce..832a0edcda 100644 --- a/tool/template-sidebar_nav.html +++ b/tool/template-sidebar_nav.html @@ -13,14 +13,25 @@
@@ -29,27 +40,5 @@
{% endfor %} - {# special Ripple Resources section #} -
- - -
-
- -
-
- -
- diff --git a/tool/template-subcat-landing.html b/tool/template-subcat-landing.html new file mode 100644 index 0000000000..05bc5185f9 --- /dev/null +++ b/tool/template-subcat-landing.html @@ -0,0 +1,26 @@ +{% extends "template-base.html" %} + +{% block sidebar %} +{% if currentpage.sidebar != "disabled" %} + + {% include "template-sidebar_nav.html" %} + +{% endif %} +{% endblock %} + +{% block main %} +

{{ currentpage.name }}

+ +
+

Pages in this subcategory:

+ +
+{% endblock %}