mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 03:35:51 +00:00
Semi-working 5-layer templates
This commit is contained in:
mDuo13
219
5layers.yml
Normal file
219
5layers.yml
Normal file
@@ -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
|
||||
@@ -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;
|
||||
}
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
58
tool/template-5layerindex.html
Normal file
58
tool/template-5layerindex.html
Normal file
@@ -0,0 +1,58 @@
|
||||
{% extends "template-base.html" %}
|
||||
{% block head %}
|
||||
|
||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
|
||||
<!--[if lt IE 9]>
|
||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
|
||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
{% endblock %}
|
||||
|
||||
{% block bodyclasses %}xrp-ledger-dev-portal no-sidebar{% endblock %}
|
||||
|
||||
{% block breadcrumbs %}{% endblock %}
|
||||
|
||||
{% block main %}
|
||||
<div class="container portal-index">
|
||||
<h2>All Pages</h2>
|
||||
<div class="row">
|
||||
<div class="col-md-8">
|
||||
<ul>
|
||||
{% for page in pages %}
|
||||
<li><a href="{{ page.html }}">{{ page.name }}</a></li>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<aside class="related-projects">
|
||||
<h3>Related Projects</h3>
|
||||
<div class="project">
|
||||
<p><a class="client-portal-link" href="https://clients.ripple.com/" target="_blank">
|
||||
<img class="project-icon" src="assets/img/RippleNet-condensed.svg" />
|
||||
<span class="project-name">Ripple Client Portal</span>
|
||||
<span class="login-required">(login required)</span>
|
||||
</a></p>
|
||||
<p class="project-summary">For financial institutions using Ripple's proprietary solutions to send money globally.</p>
|
||||
</div>
|
||||
<div class="project">
|
||||
<p><a class="interledger-link" href="https://interledger.org/" target="_blank">
|
||||
<img class="project-icon" src="assets/img/ilp_logo.svg" />
|
||||
<span class="project-name">Interledger</span>
|
||||
</a></p>
|
||||
<p class="project-summary">An open protocol suite for connecting all forms of digital money.</p>
|
||||
</aside>
|
||||
|
||||
<!-- Disclaimer block -->
|
||||
<div class="container build-disclaimer">
|
||||
<p>
|
||||
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 <strong><em>does not</em></strong> endorse any specific resource and makes no representations or warranties with respect to the resources listed.
|
||||
</p>
|
||||
<p>
|
||||
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 <a href="https://www.fincen.gov/resources/statutes-regulations/guidance/application-fincens-regulations-persons-administering">2013 guidance issued by FinCEN</a> 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 <a href="https://www.fincen.gov">https://www.fincen.gov</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
{% endblock %}
|
||||
@@ -46,9 +46,18 @@
|
||||
{% block breadcrumbs %}
|
||||
<ul class="breadcrumb">
|
||||
<li class="crumb-top"><a href="index.html" style="display: none;"> </a></li>
|
||||
{% if currentpage.category %}
|
||||
{% if currentpage.funnel and currentpage != pages|selectattr('funnel', 'equalto', currentpage.funnel)|first %}
|
||||
<li class="active crumb-category"><a href="{{ (pages|selectattr('funnel', 'equalto', currentpage.funnel)|first).html }}">{{ currentpage.funnel }}</a></li>
|
||||
{% endif %}
|
||||
{% if currentpage.doc_type and currentpage != pages|selectattr('doc_type', 'equalto', currentpage.doc_type)|first%}
|
||||
<li class="active crumb-category"><a href="{{ (pages|selectattr('doc_type', 'equalto', currentpage.doc_type)|first).html }}">{{ currentpage.doc_type }}</a></li>
|
||||
{% endif %}
|
||||
{% if currentpage.category and currentpage != pages|selectattr('category', 'equalto', currentpage.category)|first %}
|
||||
<li class="active crumb-category"><a href="{{ (pages|selectattr('category', 'equalto', currentpage.category)|first).html }}">{{ currentpage.category }}</a></li>
|
||||
{% endif %}
|
||||
{% if currentpage.subcategory and currentpage != pages|selectattr('subcategory', 'equalto', currentpage.subcategory)|first %}
|
||||
<li class="active crumb-category"><a href="{{ (pages|selectattr('subcategory', 'equalto', currentpage.subcategory)|first).html }}">{{ currentpage.subcategory }}</a></li>
|
||||
{% endif %}
|
||||
<li class="active crumb-current">{{ currentpage.name }}</li>
|
||||
</ul>
|
||||
{% endblock %}
|
||||
|
||||
25
tool/template-cat-landing.html
Normal file
25
tool/template-cat-landing.html
Normal file
@@ -0,0 +1,25 @@
|
||||
{% extends "template-base.html" %}
|
||||
|
||||
{% block sidebar %}
|
||||
{% if currentpage.sidebar != "disabled" %}
|
||||
|
||||
{% include "template-sidebar_nav.html" %}
|
||||
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
||||
{% block main %}
|
||||
<h1 class="main-page-header">{{ currentpage.name }}</h1>
|
||||
|
||||
<div class='content'>
|
||||
<h2>Pages in this category:</h2>
|
||||
<ul class="cat_pagelist">
|
||||
{% for page in pages %}
|
||||
{% if page.category == currentpage.category and
|
||||
page.name != currentpage.name %}
|
||||
<li><a href="{{page.html}}">{{page.name}}</a></li>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
{% endblock %}
|
||||
22
tool/template-landing-docs.html
Normal file
22
tool/template-landing-docs.html
Normal file
@@ -0,0 +1,22 @@
|
||||
{% extends "template-base.html" %}
|
||||
|
||||
{% block sidebar %}
|
||||
{% if currentpage.sidebar != "disabled" %}
|
||||
|
||||
{% include "template-sidebar_nav.html" %}
|
||||
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
||||
{% block main %}
|
||||
<h1 class="main-page-header">{{ currentpage.name }}</h1>
|
||||
|
||||
<section>
|
||||
<div class="panel panel-default">
|
||||
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.
|
||||
</div>
|
||||
<div class="panel panel-default">
|
||||
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.
|
||||
</div>
|
||||
</section>
|
||||
{% endblock %}
|
||||
@@ -13,15 +13,26 @@
|
||||
<div id="sidenav_collapse_{{loop.index}}" class="collapse{% if currentpage.category == cat %} in{% endif %}" role="tabpanel" aria-labelledby="sidenav_cat_head_{{loop.index}}">
|
||||
<div class="panel-body">
|
||||
<ul class="sidebar_cat_pagelist">
|
||||
{% for page in pages %}
|
||||
{% if page.category == cat %}
|
||||
{% if page == currentpage %}
|
||||
<li><a class="active" href="#main_content_body">{{ page.name }}</a></li>
|
||||
{% set nosubcatpages = pages|selectattr("category", "equalto", cat)|selectattr("subcategory", "undefined") %}
|
||||
{% for page in nosubcatpages %}
|
||||
<li class="nosubcat-page"><a href=" {{ page.html }}">{{ page.name }}</a></li>
|
||||
{% endfor %}
|
||||
|
||||
{% set subcatpages = pages|selectattr("category", "equalto", cat)|selectattr("subcategory", "defined") %}
|
||||
{% for subcat in subcatpages|groupby("subcategory") %}
|
||||
{% if subcat.list[0].name != subcat.grouper %}
|
||||
<li class="subcategory_title"><a>{{ subcat.grouper }}</a></li>
|
||||
{% else %}
|
||||
<li><a href="{{ page.html }}">{{ page.name }}</a></li>
|
||||
<li class="subcategory_title"><a href="{{subcat.list[0].html}}">{{ subcat.grouper }}</a></li>
|
||||
{% endif %}
|
||||
{% for page in subcat.list if page.name != subcat.grouper %}
|
||||
{% if page == currentpage %}
|
||||
<li><a class="active subpage" href="#main_content_body">{{ page.name }}</a></li>
|
||||
{% else %}
|
||||
<li><a class="subpage" href="{{ page.html }}">{{ page.name }}</a></li>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div><!-- /.panel-body -->
|
||||
</div><!-- /#sidenav_collapse{{loop.index}} -->
|
||||
@@ -29,27 +40,5 @@
|
||||
</div><!-- /.panel -->
|
||||
{% endfor %}
|
||||
|
||||
{# special Ripple Resources section #}
|
||||
<div class="panel panel-default">
|
||||
<div class="panel-heading" role="tab" id="sidenav_cat_head_ripple_resources">
|
||||
<h5 class="panel-title">
|
||||
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#sidenav_accordion" href="#sidenav_collapse_ripple_resources" aria-expanded="true" aria-controls="sidenav_collapse_ripple_resources">
|
||||
Ripple Resources
|
||||
</a>
|
||||
</h5>
|
||||
</div><!-- /.panel-heading -->
|
||||
|
||||
<div id="sidenav_collapse_ripple_resources" class="collapse" role="tabpanel" aria-labelledby="sidenav_cat_head_ripple_resources">
|
||||
<div class="panel-body">
|
||||
<ul class="sidebar_cat_pagelist">
|
||||
<li><a href="https://ripple.com/category/dev-blog/">Dev Blog</a></li>
|
||||
<li><a href="https://github.com/ripple/">Open Source on GitHub</a></li>
|
||||
<li><a href="https://ripple.com/">Corporate Website</a></li>
|
||||
</ul>
|
||||
</div><!-- /.panel-body -->
|
||||
</div><!-- /#sidenav_collapseripple_resources -->
|
||||
|
||||
</div><!-- /.panel -->
|
||||
|
||||
</div><!-- /#sidenav_accordion -->
|
||||
</div><!-- /.guide_toc -->
|
||||
|
||||
26
tool/template-subcat-landing.html
Normal file
26
tool/template-subcat-landing.html
Normal file
@@ -0,0 +1,26 @@
|
||||
{% extends "template-base.html" %}
|
||||
|
||||
{% block sidebar %}
|
||||
{% if currentpage.sidebar != "disabled" %}
|
||||
|
||||
{% include "template-sidebar_nav.html" %}
|
||||
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
||||
{% block main %}
|
||||
<h1 class="main-page-header">{{ currentpage.name }}</h1>
|
||||
|
||||
<div class='content'>
|
||||
<h2>Pages in this subcategory:</h2>
|
||||
<ul class="subcat_pagelist">
|
||||
{% for page in pages %}
|
||||
{% if page.category == currentpage.category and
|
||||
page.subcategory == currentpage.subcategory and
|
||||
page.name != currentpage.name %}
|
||||
<li><a href="{{page.html}}">{{page.name}}</a></li>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
{% endblock %}
|
||||
Reference in New Issue
Block a user