mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-19 11:15:49 +00:00
References landing (& placeholders to make it look good)
This commit is contained in:
mDuo13
77
5layers.yml
77
5layers.yml
@@ -205,8 +205,9 @@ pages:
|
||||
- name: References
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
template: template-landing-children.html
|
||||
template: template-landing-references.html
|
||||
html: landing-references.html
|
||||
sidebar: disabled
|
||||
targets:
|
||||
- local
|
||||
|
||||
@@ -224,6 +225,7 @@ pages:
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: rippled API Public Methods
|
||||
blurb: Get data from the XRP Ledger and submit transactions using these public API methods.
|
||||
html: reference-rippled-public.html
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
@@ -312,11 +314,23 @@ pages:
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: rippled API Admin Methods
|
||||
blurb: Administer a rippled server with these admin API methods.
|
||||
html: reference-rippled-admin.html
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- name: Server Control Methods
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: rippled API Admin Methods
|
||||
subcategory: Server Control Methods
|
||||
html: reference-rippled-admin-server-control-methods.html
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- md: rippled-api-methods/ledger_accept.md
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
@@ -331,6 +345,53 @@ pages:
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Transaction Format
|
||||
blurb: A transaction is the only way to modify the XRP Ledger. Get details about its required format.
|
||||
targets:
|
||||
- local
|
||||
|
||||
- name: Transaction Common Fields #TODO: replace with real md file
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Transaction Format
|
||||
html: reference-rippled-transactions-common-fields.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- name: Transaction Types #TODO: replace with real md file
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Transaction Format
|
||||
html: reference-rippled-transaction-types.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- name: Transaction Results #TODO: replace with real md file
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Transaction Format
|
||||
html: reference-rippled-transaction-results.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- md: reference-ledger-format.md
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Ledger Data Format
|
||||
blurb: Learn about individual data objects that comprise the XRP Ledger's shared state.
|
||||
targets:
|
||||
- local
|
||||
|
||||
- name: API Conventions #TODO: replace with real md file
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: API Conventions
|
||||
html: reference-rippled-api-conventions.html
|
||||
blurb: Lorem ipsum dolor sit amet...
|
||||
targets:
|
||||
- local
|
||||
|
||||
@@ -338,6 +399,12 @@ pages:
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
category: Data API
|
||||
blurb: Access more XRP Ledger data, including transaction history and analytics.
|
||||
curated_anchors:
|
||||
- name: Methods
|
||||
anchor: "#api-method-reference"
|
||||
- name: API Conventions
|
||||
anchor: "#api-conventions"
|
||||
targets:
|
||||
- local
|
||||
|
||||
@@ -347,6 +414,14 @@ pages:
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
category: RippleAPI for JavaScript
|
||||
blurb: Official client library to the XRP Ledger. Available for JavaScript only.
|
||||
curated_anchors:
|
||||
- name: Transactions
|
||||
anchor: "#transaction-overview"
|
||||
- name: Basic Types
|
||||
anchor: "#basic-types"
|
||||
- name: Methods
|
||||
anchor: "#api-methods"
|
||||
filters:
|
||||
- remove_doctoc
|
||||
- add_version
|
||||
|
||||
@@ -3,9 +3,9 @@
|
||||
{% block bodyclasses %}landing{% endblock %}
|
||||
|
||||
{% block main %}
|
||||
<section class="container-fluid">
|
||||
<h1 class="main-page-header">XRP Ledger Documentation</h1>
|
||||
<section class="container-fluid px-5 pb-5 pt-0">
|
||||
<div class="row">
|
||||
<h1 class="main-page-header">XRP Ledger Documentation</h1>
|
||||
<div class="blurb col-sm-12">
|
||||
{{content}}
|
||||
</div>
|
||||
|
||||
84
tool/template-landing-references.html
Normal file
84
tool/template-landing-references.html
Normal file
@@ -0,0 +1,84 @@
|
||||
{% extends "template-base.html" %}
|
||||
|
||||
{% block bodyclasses %}landing{% endblock %}
|
||||
|
||||
{% block main %}
|
||||
<section class="container-fluid px-5 pb-3 pt-0">
|
||||
<div class="row">
|
||||
<h1 class="main-page-header">References</h1>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="container-fluid bg-light p-5">
|
||||
|
||||
<h2><a href="reference-rippled-api.html">rippled API Reference</a></h2>
|
||||
<div class="blurb col-sm-12">
|
||||
<p>Use the <code>rippled</code> API to communicate with a <code>rippled</code> server, the core peer-to-peer server that manages the XRP Ledger.</p>
|
||||
</div>
|
||||
|
||||
<div class="card-deck p-2">
|
||||
|
||||
{% for page in pages|selectattr("supercategory", "equalto", "rippled API")|list %}
|
||||
{% if loop.index != 1 and page == pages|selectattr("category", "equalto", page.category)|first %}
|
||||
<div class="card">
|
||||
{#{% set parent_page = pages|selectattr("html", "equalto", "reference-rippled-public.html")|first %}#}
|
||||
<div class="card-header">
|
||||
<h3 class="card-title"><a href="{{page.html}}">{{page.name}}</a></h3>
|
||||
</div><!--/.card-header-->
|
||||
<div class="card-body">
|
||||
<p class="ref-blurb">{{page.blurb}}</p>
|
||||
{% set depth = 1 %}
|
||||
{% set parent_page = page %}
|
||||
{% include 'template-page-children.html' %}
|
||||
</div><!--/.card-body-->
|
||||
</div><!--/.card-->
|
||||
|
||||
{# go to new row after admin methods #}
|
||||
{% if page.html == "reference-rippled-admin.html" %}
|
||||
</div><!--/.card-deck-->
|
||||
<div class="card-deck p-2">
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
</div><!--/.card-deck-->
|
||||
|
||||
</section>
|
||||
|
||||
<section class="container-fluid bg-white p-5">
|
||||
|
||||
<h2>Other XRP Ledger Interfaces</h2>
|
||||
<div class="blurb col-sm-12">
|
||||
<p>Here are a few other ways to interact with the XRP Ledger.</p>
|
||||
</div>
|
||||
<div class="card-deck p-2">
|
||||
|
||||
{% for page in pages|selectattr("doc_type", "equalto", "References")|selectattr("supercategory", "ne", "rippled API") %}
|
||||
{% if loop.index != 1 and page == pages|selectattr("category", "equalto", page.category)|first %}
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<h3 class="card-title"><a href="{{page.html}}">{{page.name}}</a></h3>
|
||||
</div><!--/.card-header-->
|
||||
<div class="card-body">
|
||||
<p class="ref-blurb">{{page.blurb}}</p>
|
||||
{% if page.curated_anchors is defined %}
|
||||
<ul class="curated-links">
|
||||
{% for link in page.curated_anchors %}
|
||||
<li class="level-1"><a href="{{page.html}}{{link.anchor}}">{{link.name}}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
|
||||
{% set depth = 1 %}
|
||||
{% set parent_page = page %}
|
||||
{% include 'template-page-children.html' %}
|
||||
</div><!--/.card-body-->
|
||||
</div><!--/.card-->
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
</div><!--/.card-deck-->
|
||||
|
||||
</section>
|
||||
|
||||
{% endblock %}
|
||||
@@ -27,7 +27,6 @@
|
||||
{% else %}
|
||||
<!-- TEMPLATE ERROR: page {{parent_page.name}} is not the parent of anything? -->
|
||||
{% endif %}
|
||||
<!-- parent_level is {{parent_level}} -->
|
||||
{% if parent_level != "home" %}
|
||||
{% set childpages = pages|selectattr(parent_level, "equalto", parent_page[parent_level])|list %}
|
||||
{% endif %}
|
||||
|
||||
Reference in New Issue
Block a user