ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 03:35:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

hybrid sidebar for doc pages

Browse Source
This commit is contained in:
mDuo13
2016-02-22 19:24:21 -08:00
parent b72347591e
commit fe2bafb795
19 changed files with 150 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
concept-fee-voting.html
View File

@@ -123,7 +123,7 @@
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
<ul id="dev_nav_sidebar">
<li class="level-1">Concepts</li>
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
<li class="level-2"><a href="concept-transfer-fees.html">Transfer Fees</a></li>
@@ -132,7 +132,10 @@
<li class="level-2"><a href="concept-reserves.html">Reserves</a></li>
<li class="level-2"><a href="concept-freeze.html">Freeze</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

5
concept-fees.html
View File

@@ -123,7 +123,7 @@
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
<ul id="dev_nav_sidebar">
<li class="level-1">Concepts</li>
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
<li class="level-2"><a href="concept-transfer-fees.html">Transfer Fees</a></li>
@@ -132,7 +132,10 @@
<li class="level-2"><a href="concept-reserves.html">Reserves</a></li>
<li class="level-2"><a href="concept-freeze.html">Freeze</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

5
concept-freeze.html
View File

@@ -123,7 +123,7 @@
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
<ul id="dev_nav_sidebar">
<li class="level-1">Concepts</li>
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
<li class="level-2"><a href="concept-transfer-fees.html">Transfer Fees</a></li>
@@ -132,7 +132,10 @@
<li class="level-2"><a href="concept-reserves.html">Reserves</a></li>
<li class="level-2"><a href="concept-freeze.html">Freeze</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

9
concept-issuing-and-operational-accounts.html
View File

@@ -122,9 +122,16 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
<ul id="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Best Practices</a></li>
<li class="level-2"><a href="concept-issuing-and-operational-accounts.html">Issuing and Operational Acounts</a></li>
<li class="level-2"><a href="tutorial-gateway-guide.html">Gateway Guide</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
<div class='content'>

5
concept-paths.html
View File

@@ -123,7 +123,7 @@
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
<ul id="dev_nav_sidebar">
<li class="level-1">Concepts</li>
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
<li class="level-2"><a href="concept-transfer-fees.html">Transfer Fees</a></li>
@@ -132,7 +132,10 @@
<li class="level-2"><a href="concept-reserves.html">Reserves</a></li>
<li class="level-2"><a href="concept-freeze.html">Freeze</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

5
concept-reserves.html
View File

@@ -123,7 +123,7 @@
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
<ul id="dev_nav_sidebar">
<li class="level-1">Concepts</li>
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
<li class="level-2"><a href="concept-transfer-fees.html">Transfer Fees</a></li>
@@ -132,7 +132,10 @@
<li class="level-2"><a href="concept-reserves.html">Reserves</a></li>
<li class="level-2"><a href="concept-freeze.html">Freeze</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

5
concept-transaction-cost.html
View File

@@ -123,7 +123,7 @@
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
<ul id="dev_nav_sidebar">
<li class="level-1">Concepts</li>
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
<li class="level-2"><a href="concept-transfer-fees.html">Transfer Fees</a></li>
@@ -132,7 +132,10 @@
<li class="level-2"><a href="concept-reserves.html">Reserves</a></li>
<li class="level-2"><a href="concept-freeze.html">Freeze</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

5
concept-transfer-fees.html
View File

@@ -123,7 +123,7 @@
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
<ul id="dev_nav_sidebar">
<li class="level-1">Concepts</li>
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
<li class="level-2"><a href="concept-transfer-fees.html">Transfer Fees</a></li>
@@ -132,7 +132,10 @@
<li class="level-2"><a href="concept-reserves.html">Reserves</a></li>
<li class="level-2"><a href="concept-freeze.html">Freeze</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

12
reference-data-api.html
View File

@@ -122,9 +122,19 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
<ul id="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
<li class="level-2"><a href="reference-ledger-format.html">Ledger Format</a></li>
<li class="level-2"><a href="reference-rippleapi.html">RippleAPI</a></li>
<li class="level-2"><a href="reference-data-api.html">Ripple Data API v2</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
<div class='content'>

12
reference-ledger-format.html
View File

@@ -122,9 +122,19 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
<ul id="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
<li class="level-2"><a href="reference-ledger-format.html">Ledger Format</a></li>
<li class="level-2"><a href="reference-rippleapi.html">RippleAPI</a></li>
<li class="level-2"><a href="reference-data-api.html">Ripple Data API v2</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
<div class='content'>

12
reference-rippleapi.html
View File

@@ -122,9 +122,19 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
<ul id="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
<li class="level-2"><a href="reference-ledger-format.html">Ledger Format</a></li>
<li class="level-2"><a href="reference-rippleapi.html">RippleAPI</a></li>
<li class="level-2"><a href="reference-data-api.html">Ripple Data API v2</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
<div class='content'>

12
reference-rippled.html
View File

@@ -122,9 +122,19 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
<ul id="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
<li class="level-2"><a href="reference-ledger-format.html">Ledger Format</a></li>
<li class="level-2"><a href="reference-rippleapi.html">RippleAPI</a></li>
<li class="level-2"><a href="reference-data-api.html">Ripple Data API v2</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
<div class='content'>

12
reference-transaction-format.html
View File

@@ -122,9 +122,19 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
<ul id="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
<li class="level-2"><a href="reference-ledger-format.html">Ledger Format</a></li>
<li class="level-2"><a href="reference-rippleapi.html">RippleAPI</a></li>
<li class="level-2"><a href="reference-data-api.html">Ripple Data API v2</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
<div class='content'>

38
tool/devportal-config.yml
View File

@@ -42,21 +42,21 @@ pages:
html: reference-rippled.html
md: reference-rippled.md
ripple.com: https://ripple.com/build/rippled-apis/
sidebar: page-toc
sidebar: true
- name: Transaction Format
category: References
html: reference-transaction-format.html
md: reference-transaction-format.md
ripple.com: https://ripple.com/build/transactions/
sidebar: page-toc
sidebar: true
- name: Ledger Format
category: References
html: reference-ledger-format.html
md: reference-ledger-format.md
ripple.com: https://ripple.com/build/ledger-format/
sidebar: page-toc
sidebar: true
- name: RippleAPI
category: References
@@ -64,14 +64,14 @@ pages:
# Currently this is the only page that's fetched remotely.
md: https://raw.githubusercontent.com/ripple/ripple-lib/0.16.7/docs/index.md
ripple.com: https://ripple.com/build/rippleapi/
sidebar: page-toc
sidebar: true
- name: Ripple Data API v2
category: References
html: reference-data-api.html
md: reference-data-api.md
ripple.com: https://ripple.com/build/data-api-v2/
sidebar: page-toc
sidebar: true
# Tutorials are step-by-step guides to a specific goal
- name: RippleAPI Beginners Guide
@@ -79,21 +79,21 @@ pages:
html: tutorial-rippleapi-beginners-guide.html
md: tutorial-rippleapi-beginners-guide.md
ripple.com: https://ripple.com/build/rippleapi-beginners-guide/
sidebar: page-toc
sidebar: true
- name: rippled Setup
category: Tutorials
html: tutorial-rippled-setup.html
md: tutorial-rippled-setup.md
ripple.com: https://ripple.com/build/rippled-setup/
sidebar: page-toc
sidebar: true
- name: Reliable Transaction Submission
category: Tutorials
html: tutorial-reliable-transaction-submission.html
md: tutorial-reliable-transaction-submission.md
ripple.com: https://ripple.com/build/reliable-transaction-submission/
sidebar: page-toc
sidebar: true
# Concepts are introductions that explain a topic.
# In the Dev Portal, these are mostly summaries of RCL features.
@@ -102,49 +102,49 @@ pages:
html: concept-paths.html
md: concept-paths.md
ripple.com: https://ripple.com/build/paths/
sidebar: category-toc
sidebar: true
- name: Fees (Disambiguation)
category: Concepts
html: concept-fees.html
md: concept-fees.md
ripple.com: https://ripple.com/knowledge_center/fees-disambiguation/
sidebar: category-toc
sidebar: true
- name: Transfer Fees
category: Concepts
html: concept-transfer-fees.html
md: concept-transfer-fees.md
ripple.com: https://ripple.com/knowledge_center/transfer-fees/
sidebar: category-toc
sidebar: true
- name: Transaction Cost
category: Concepts
html: concept-transaction-cost.html
md: concept-transaction-cost.md
ripple.com: https://ripple.com/build/transaction-cost/
sidebar: category-toc
sidebar: true
- name: Fee Voting
category: Concepts
html: concept-fee-voting.html
md: concept-fee-voting.md
ripple.com: https://ripple.com/build/fee-voting/
sidebar: category-toc
sidebar: true
- name: Reserves
category: Concepts
html: concept-reserves.html
md: concept-reserves.md
ripple.com: https://ripple.com/build/reserves/
sidebar: category-toc
sidebar: true
- name: Freeze
category: Concepts
html: concept-freeze.html
md: concept-freeze.md
ripple.com: https://ripple.com/build/freeze/
sidebar: category-toc
sidebar: true
# "Best Practices" documents are mostly in the same category as tutorials
- name: Issuing and Operational Acounts
@@ -153,7 +153,7 @@ pages:
md: concept-issuing-and-operational-accounts.md
# TODO publish this article separately on the website
ripple.com: https://ripple.com/build/gateway-guide/#hot-and-cold-wallets
sidebar: page-toc
sidebar: true
# The Gateway Guide is kind of a poor fit for the "tutorials" category
- name: Gateway Guide
@@ -161,14 +161,14 @@ pages:
html: tutorial-gateway-guide.html
md: tutorial-gateway-guide.md
ripple.com: https://ripple.com/build/gateway-guide/
sidebar: page-toc
sidebar: true
# API tools are interactive software for interfacing with real APIs
- name: WebSocket API Tool
category: API Tools
html: ripple-api-tool.html
ripple.com: https://ripple.com/build/websocket-tool/
sidebar: custom
sidebar: true
targets:
- local
- ripple.com
@@ -179,7 +179,7 @@ pages:
html: data-api-v2-tool.html
methods_js: js/apitool-methods-data_v2.js
rest_host: https://data.ripple.com
sidebar: custom
sidebar: true
targets:
- local
- ripple.com

13
tool/template-doc.html
View File

@@ -20,24 +20,21 @@
{% endblock %}
{% block sidebar %}
{% if currentpage.sidebar == "page-toc" %}
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
{% elif currentpage.sidebar == "category-toc" %}
{% if currentpage.sidebar %}
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
<ul id="dev_nav_sidebar">
<li class="level-1">{{ currentpage.category }}</li>
<li class="level-1"><a href="index.html">Category: {{ currentpage.category }}</a></li>
{% for page in pages %}
{% if page.category == currentpage.category %}
<li class="level-2"><a href="{{ page.html }}">{{ page.name }}</a></li>
{% endif %}
{% endfor %}
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
{% endif %}
{% endblock %}

9
tutorial-gateway-guide.html
View File

@@ -122,9 +122,16 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
<ul id="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Best Practices</a></li>
<li class="level-2"><a href="concept-issuing-and-operational-accounts.html">Issuing and Operational Acounts</a></li>
<li class="level-2"><a href="tutorial-gateway-guide.html">Gateway Guide</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
<div class='content'>

10
tutorial-reliable-transaction-submission.html
View File

@@ -122,9 +122,17 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
<ul id="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
<li class="level-2"><a href="tutorial-rippled-setup.html">rippled Setup</a></li>
<li class="level-2"><a href="tutorial-reliable-transaction-submission.html">Reliable Transaction Submission</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
<div class='content'>

10
tutorial-rippleapi-beginners-guide.html
View File

@@ -122,9 +122,17 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
<ul id="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
<li class="level-2"><a href="tutorial-rippled-setup.html">rippled Setup</a></li>
<li class="level-2"><a href="tutorial-reliable-transaction-submission.html">Reliable Transaction Submission</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
<div class='content'>

10
tutorial-rippled-setup.html
View File

@@ -122,9 +122,17 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
<div id="cont">
</div>
<ul id="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
<li class="level-2"><a href="tutorial-rippled-setup.html">rippled Setup</a></li>
<li class="level-2"><a href="tutorial-reliable-transaction-submission.html">Reliable Transaction Submission</a></li>
</ul>
<hr />
<h5>In this page:</h5>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
<div class='content'>