Docs landing page (no CSS)

This commit is contained in:
mDuo13
2018-04-18 13:29:43 -07:00
parent fffb735523
commit 2147fef9a9
5 changed files with 136 additions and 13 deletions

View File

@@ -47,10 +47,19 @@ targets:
pages:
- name: Docs
md: landing-docs.md
funnel: Docs
template: template-landing-docs.html
html: landing-docs.html
sidebar: disabled
recently_updated:
- tutorial-reliable-transaction-submission.html
- tutorial-checks-send.html
- reference-amendments.html
doc_type_blurbs:
Concepts: Learn the "what" and "why" behind fundamental aspects of the XRP Ledger.
Tutorials: Get step-by-step guidance to perform common tasks with the XRP Ledger.
References: Look up the ins-and-outs of our APIs, including sample requests and responses.
targets:
- local
@@ -244,6 +253,35 @@ pages:
targets:
- local
- name: Tutorials #TODO: real page content
funnel: Docs
doc_type: Tutorials
template: template-landing-category.html
targets:
- local
- name: Send and Receive Money
funnel: Docs
doc_type: Tutorials
category: Send and Receive Money
template: template-landing-category.html
targets:
- local
- md: tutorial-reliable-transaction-submission.md
funnel: Docs
doc_type: Tutorials
category: Send and Receive Money
targets:
- local
- md: tutorial-checks-send.md
funnel: Docs
doc_type: Tutorials
category: Send and Receive Money
targets:
- local
- name: Use Cases
funnel: Use Cases
html: use-cases.html
@@ -267,7 +305,7 @@ pages:
- name: WebSocket API Tool
funnel: Dev Tools
html: ripple-api-tool.html
html: websocket-api-tool.html
sidebar: custom
targets:
- local
@@ -305,7 +343,7 @@ pages:
targets:
- local
- md: reference-amendments.md
- md: reference-amendments.md # TODO: rename to news-amendments.md
funnel: News
targets:
- local

1
content/landing-docs.md Normal file
View File

@@ -0,0 +1 @@
Dive into our documentation and start integrating with the XRP Ledger.

View File

@@ -36,7 +36,7 @@
</head>
<body class="xrp-ledger-dev-portal {% block bodyclasses %}sidebar-primary{% endblock %}">
<body class="xrp-ledger-dev-portal {% if currentpage.sidebar != "disabled" %}sidebar-primary {% endif %}{% block bodyclasses %}{% endblock %}">
<header role="banner" class="banner navbar navbar-default navbar-fixed-top initial_header">
<div class="container">
<div class="navbar-header">
@@ -69,9 +69,11 @@
<div class="wrap container" role="document" id="main_content_wrapper">
{% if currentpage.sidebar != "disabled" %}
<aside class="sidebar" role="complementary">
{% block sidebar %}{% endblock %}
</aside>
{% endif %}
<main class="main" role="main" id="main_content_body">
{% block breadcrumbs %}
{% include 'template-breadcrumbs.html' %}

View File

@@ -1,15 +1,18 @@
{% 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>
<h1 class="main-page-header">XRP Ledger Documentation</h1>
<section class="container">
<div class="row">
<div class="blurb col-sm-12">
{{content}}
</div>
</div>
</section>
<section class="container">
<div class="row">
@@ -17,21 +20,100 @@
{% for page in pages %}
{% if page.doc_type is defined and page.doc_type not in doc_types %}
{% set doc_type_top = pages|selectattr('doc_type', 'equalto', page.doc_type)|first %}
<div class="col-sm-3">
<div class="col-sm-4">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title"><a href="{{doc_type_top.html}}">{{doc_type_top.name}}</a></h3>
</div><!--/.panel-heading-->
<div class="panel-body">
{% if currentpage.doc_type_blurbs[page.doc_type] is defined %}
<p class="doc-type-blurb">{{currentpage.doc_type_blurbs[page.doc_type]}}</p>
{% endif %}
{% set parent_page = doc_type_top %}
{% set depth = 3 %}
{% set depth = 1 %}
{% include 'template-page-children.html' %}
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-sm-3-->
</div><!--/.col-sm-4-->
{% set _ = doc_types.append(page.doc_type) %}
{% endif %}
{% endfor %}
</div><!--/.row-->
<div class="row">
<div class="col-sm-3">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title">Get Started</h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<div class="curated-links">
<ul>
<li><a href="websocket-api-tool.html">Make a call to the rippled API</a></li>
<li><a href="xrp-test-net-faucet.html">Access the XRP Ledger Test Net</a></li>
<li><a href="landing-concepts.html">Understand XRP Ledger Concepts</a></li>
</ul>
</div><!--/.curated-links-->
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-sm-3-->
<div class="col-sm-3">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title">Popular Docs</h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<div class="curated-links">
<ol>
<li><a href="reference-rippled-public.html">rippled API Public Methods Reference</a></li>
<li><a href="concept-accounts.html">Accounts</a></li>
<li><a href="rippled-setup.html">rippled Server Setup</a></li>
<li><a href="reference-rippleapi.html">RippleAPI for JavaScript</a></li>
</ol>
</div><!--/.curated-links-->
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-sm-3-->
<div class="col-sm-3">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title">Popular Tools</h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<div class="curated-links">
<ol>
<li><a href="xrp-ledger-rpc-tool.html">RPC Tool</a></li>
<li><a href="websocket-api-tool.html">WebSocket API Tool</a></li>
<li><a href="xrp-test-net-faucet.html">XRP Test Net Faucet</a></li>
<li><a href="data-api-v2-tool.html">Data API v2 Tool</a></li>
<li><a href="ripple-txt-validator.html">ripple.txt Validator</a></li>
</ol>
</div><!--/.curated-links-->
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-sm-3-->
<div class="col-sm-3">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title">Recently Updated</h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<div class="curated-links">
<ol>
{% for link in currentpage.recently_updated %}
{% set linkpage = pages|selectattr("html", "equalto", link)|first %}
<li><a href="{{linkpage.html}}">{{linkpage.name}}</a></li>
{% endfor %}
</ol>
</div><!--/.curated-links-->
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-sm-3-->
</div><!--/.row-->
</section>
{% endblock %}

View File

@@ -1,6 +1,6 @@
{% extends "template-base.html" %}
{% block bodyclasses %}sidebar-primary page-test-net{% endblock %}
{% block bodyclasses %}page-test-net{% endblock %}
{% block main %}