From 539d23bfcec0f2d96e27d864a3c894455869c1aa Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 3 Feb 2015 00:24:44 -0800 Subject: [PATCH] [FEATURE] page templating system and parser --- consensus-whitepaper.html | 214 --------- content/whitepapers.md | 13 + css/custom-landing.css | 9 - css/custom.css | 38 +- css/main.css | 4 +- exchange_to_gateway.html | 164 ------- gateway_guide.html | 172 ++++++++ gateway_services.html | 256 +++++------ gatewayd.html | 238 +++++----- guidelines.html | 438 ------------------- historical_data.html | 172 ++++++++ index.html | 189 ++++---- js/fixsidebarscroll.js | 8 +- js/jquery.gensidebar.js | 13 + reliable_tx.html | 232 +++++----- rest-api-tool.html | 334 +++++++------- ripple-api-tool.html | 319 +++++++------- ripple-rest.html | 238 +++++----- rippled-apis.html | 279 ++++++------ terms-conditions.html | 190 -------- tool/buttonize.py | 25 ++ tool/pages.json | 63 +++ tool/parse_pages.py | 100 +++++ tool/template-base.html | 134 ++++++ tool/template-doc.html | 65 +++ tool/template-index.html | 137 ++++++ tool/template-rest-api-tool.html | 81 ++++ tool/template-ripple-api-tool.html | 86 ++++ transactions.html | 253 +++++------ vendor/flatdoc/v/0.8.0/theme-white/style.css | 4 +- whitepapers.html | 172 ++++++++ 31 files changed, 2507 insertions(+), 2133 deletions(-) delete mode 100644 consensus-whitepaper.html create mode 100644 content/whitepapers.md delete mode 100644 exchange_to_gateway.html create mode 100644 gateway_guide.html delete mode 100644 guidelines.html create mode 100644 historical_data.html create mode 100644 js/jquery.gensidebar.js delete mode 100644 terms-conditions.html create mode 100644 tool/buttonize.py create mode 100644 tool/pages.json create mode 100644 tool/parse_pages.py create mode 100644 tool/template-base.html create mode 100644 tool/template-doc.html create mode 100644 tool/template-index.html create mode 100644 tool/template-rest-api-tool.html create mode 100644 tool/template-ripple-api-tool.html create mode 100644 whitepapers.html diff --git a/consensus-whitepaper.html b/consensus-whitepaper.html deleted file mode 100644 index 96189f89f6..0000000000 --- a/consensus-whitepaper.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - - - Ripple Developer Portal: Consensus Whitepaper - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- -

 Download the Consensus Whitepaper

- - -
-
-
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
-
-

Join the mailing list!

- - - - -
-
- - - -
- -
-
- - -
-
-
-
- - diff --git a/content/whitepapers.md b/content/whitepapers.md new file mode 100644 index 0000000000..dfa9c10c45 --- /dev/null +++ b/content/whitepapers.md @@ -0,0 +1,13 @@ +Ripple Whitepapers +================== + +Ripple has published several whitepapers on the benefits and workings of the Ripple technology stack. The following is a brief selection of useful papers: + +* [Ripple Primer](https://ripple.com/ripple_primer.pdf) (PDF) +* [Gateway whitepaper](https://ripple.com/ripple-gateways.pdf) (PDF) +* [Market makers whitepaper](https://ripple.com/ripple-mm.pdf) (PDF) +* [Financial institutions whitepaper](https://ripple.com/ripple-FIs.pdf) (PDF) +* [The Ripple Protocol: A Deep Dive for Finance Professionals](https://ripple.com/files/ripple_deep_dive_final.pdf) (PDF) +* [The Ripple Protocol Consensus Algorithm](https://ripple.com/files/ripple_consensus_whitepaper.pdf) (PDF) + +You can find further information about Ripple in the [Knowledge Center](https://ripple.com/knowledge-center/). diff --git a/css/custom-landing.css b/css/custom-landing.css index aa13d3d8ad..12e5f4b6a5 100644 --- a/css/custom-landing.css +++ b/css/custom-landing.css @@ -2,15 +2,6 @@ global *********** */ -body { - background-color: #f5f5f5; - font-family: 'Open Sans', sans-serif; -} - -.wrapper { - background-color: #fff; -} - a:hover { text-decoration: none; } diff --git a/css/custom.css b/css/custom.css index 47f44730d2..e6a0d23d4d 100644 --- a/css/custom.css +++ b/css/custom.css @@ -10,7 +10,6 @@ body .content-root { } .header { - background: #346AA9; height: 50px; -webkit-box-shadow: none; box-shadow: none; @@ -204,6 +203,38 @@ code { max-height: 14em; overflow: auto;} margin-bottom: 183px; } +.tableofcontents { + z-index: 0; +} + +.tableofcontents .level-1 { + margin: 10px 0 3px 0; + text-transform: uppercase; +} + +.tableofcontents .level-1 a { + color: #000; + font-weight: bold; +} + +.tableofcontents .level-2 { + margin-left: 2em; +} + +.tableofcontents .level-3 { + margin-left: 4em; +} + +.tableofcontents .level-3 a { + color: #999; +} + +.tableofcontents .level-3 a:hover { + color: #666; +} + + + .header-subnav li a:active { color: #f09 !important; } @@ -511,6 +542,7 @@ body #online_state { margin-top:20px; color: #878787; padding-bottom: 20px; + z-index: 2; } .container .text-muted { @@ -531,6 +563,10 @@ ul.footer_links a:hover { text-decoration: underline; } +.footer h4 { + font-weight: bold; +} + /************ Mail chimp *********** */ diff --git a/css/main.css b/css/main.css index cb0895cc58..11855b208a 100644 --- a/css/main.css +++ b/css/main.css @@ -717,7 +717,7 @@ body:not(.no-literate) .guidelines-content .badge-example .badge-location:after border: solid 1px #CED3E1; background: rgba(206, 211, 225, 0.5); } -.header { +/*.header { background: #5d89ae; padding-top: 0; padding-bottom: 0; @@ -767,7 +767,7 @@ body:not(.no-literate) .guidelines-content .badge-example .badge-location:after .header h1 + ul li.active a, .header h1 + ul li:hover a { background: rgba(255, 255, 255, 0.1); -} +}*/ @media (min-width: 1180px) { body:not(.no-literate) .modal .modal-dialog { width: 700px; diff --git a/exchange_to_gateway.html b/exchange_to_gateway.html deleted file mode 100644 index 92a8bf9985..0000000000 --- a/exchange_to_gateway.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - - Ripple Developer Portal: Exchange to Gateway Tutorial - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
DRAFT
- - - -
-
-
-
-
- -
-
-
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
-
-
- - - diff --git a/gateway_guide.html b/gateway_guide.html new file mode 100644 index 0000000000..b016b67499 --- /dev/null +++ b/gateway_guide.html @@ -0,0 +1,172 @@ + + + + + + + + Gateway Guide - Ripple Developer Portal + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+
+ + + diff --git a/gateway_services.html b/gateway_services.html index dcd08006cd..971382bfec 100644 --- a/gateway_services.html +++ b/gateway_services.html @@ -1,72 +1,63 @@ - + - - - + + + - Ripple Developer Portal: Gateway Services + Gateway Services - Ripple Developer Portal - - - - - - - - - - - - + + + - - - + + - - - + + + - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - -
DRAFT
- + - -
-
-
+
+
+
+
+
+
+
+
-
- -
-
-
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
-
+ - diff --git a/gatewayd.html b/gatewayd.html index 9926ae382d..2884593725 100644 --- a/gatewayd.html +++ b/gatewayd.html @@ -1,57 +1,63 @@ - - + + - - - + + + - Ripple Developer Portal: Gatewayd + Gatewayd - Ripple Developer Portal - - - + + + - - - - - - - - - + + - - - - - - - + + + - - - - - - - - + + + + + + + + + + + + + + - - + $(".flatdoc-content").empty(); + $(".content-root .menubar .menu").empty(); + Flatdoc.run({ + fetcher: Flatdoc.file('content/gatewayd.md') + }); + $(document).on('flatdoc:ready', function() { + $().multicode_tabs(); + hljs.initHighlighting(); + }); + + + + + + + + + + + + + - + - -
-
-
+
+
+
+
+
+
+
+
-
-
-
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
+
+ diff --git a/guidelines.html b/guidelines.html deleted file mode 100644 index e80b429b80..0000000000 --- a/guidelines.html +++ /dev/null @@ -1,438 +0,0 @@ - - - - - - - - Ripple Dev Portal: Brand Guidelines - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
-

Brand use and Guidelines

-

- This document is to serve as a reference for organizations on how to use and associate with the - official Ripple brand. Correct usage of the guidelines outlined within this document will help create a - clear and defined ecosystem, resulting in greater trust and adoption by users of the Ripple network. -

-
- Your agreement to these Terms and Conditions is required to use the Ripple brand and download the assets on this page. -
-
- - - - - - - - Download All - -
- - - -
- - - - - - -
-
- -
-

Official Branding Use

-

- - The Ripple Triskelion can be freely used for the purposes of branding your business (whether it be a gateway, blog, smartphone app, or otherwise) so long as it is modified in a manner that gives it new meaning or places it in a new context. Unadulterated reproduction of the original Triskelion provided on the Ripple Artwork page is not allowed. -

- - -
-
-
-
- -
-
- Acceptable use of the Ripple Triskelion -

- Ripple Labs has incorporated the Triskelion into a logo with a beaker to emphasize the connection to a place of research and experimentation, this is placing it in a new context. -

-
-
-
-
- -
-
- Acceptable use of the Ripple trademark -

- Creatively integrate Ripple into your product or business name -

-
-
-
- -
- -
-
-
- -
-
- Unacceptable uses of the Ripple Triskelion -

- The Triskelion is unmodified and the gateway name Ripple Antarctica is vague and unspecific regarding the business function. -

-
-
-
-
- -
-
- Unacceptable use of the Ripple trademark -
    -
  • Use names or titles that include Ripple followed by a generic noun, adjective, etc. that doesn’t provide any unique value to your product branding.
    • -
  • - Suggest that your product or business is endorsed or affiliated with Ripple Labs or the Ripple protocol in any way. -
    • -
  • - Modify the word “Ripple” by adding or removing letters to create a verb tense of some kind. -
    • -
-
-
-
-
-
- - - -
-

Attribution Badge

-

- BUILT ON RIPPLE: We have created these attribution badges to help strengthen and build equity - in the masterbrand, and to create a - clear relationship between the various gateways and companies that operate on the Ripple network. -

- - -
-
- - Full Color -
-
- - On Light BG -
-
- - On Dark BG -
-
-
- - Secondary placement - Left - Primary placement - Center - Secondary placement - Right -
- -
-
-
- - - - - -
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
-
-

-
-
- - diff --git a/historical_data.html b/historical_data.html new file mode 100644 index 0000000000..b5a01e97ac --- /dev/null +++ b/historical_data.html @@ -0,0 +1,172 @@ + + + + + + + + Historical Data API - Ripple Developer Portal + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+
+ + + diff --git a/index.html b/index.html index 36618b0717..120608da0b 100644 --- a/index.html +++ b/index.html @@ -1,23 +1,22 @@ - + - - - Ripple Dev Portal Resources + + + + Overview - Ripple Developer Portal + + + + + + + - - - - - - - - - - - + + @@ -27,12 +26,25 @@ + + + + + + + + + + + + + + + - - -
- - -
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- -
-
-
- -
- - - - - + + diff --git a/js/fixsidebarscroll.js b/js/fixsidebarscroll.js index 042d1ba8a6..b27c9c4f45 100644 --- a/js/fixsidebarscroll.js +++ b/js/fixsidebarscroll.js @@ -1,7 +1,9 @@ $(window).scroll(function() { - if($(window).scrollTop() + $(window).height() > $(document).height() - 183) { - $(".menubar.fixed").addClass("leaveroomforfooter"); + var footerpos = parseInt($(".footer").offset().top); + var scrollpos = $(window).scrollTop() + $(window).height(); + if(scrollpos - footerpos > 0) { + $(".menubar.fixed").css("margin-bottom", scrollpos-footerpos); } else { - $(".menubar.fixed").removeClass("leaveroomforfooter"); + $(".menubar.fixed").css("margin-bottom", 0); } }); diff --git a/js/jquery.gensidebar.js b/js/jquery.gensidebar.js new file mode 100644 index 0000000000..081de1ba88 --- /dev/null +++ b/js/jquery.gensidebar.js @@ -0,0 +1,13 @@ +$(document).ready(function() { + tableOfContents = $("
- -
-
-
+
+
+
+
+
+
+
+
-
-
-
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
+
+ diff --git a/rest-api-tool.html b/rest-api-tool.html index 4c744e2add..9a43944667 100644 --- a/rest-api-tool.html +++ b/rest-api-tool.html @@ -1,39 +1,36 @@ - - + + - - - + + + - Ripple Developer Portal: Ripple-REST API Tool + Ripple-REST API Tool - Ripple Developer Portal - - - + + + - - + + - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + -
-
-
-
-
    -
  • Generate Wallet
    • -
  • Get Account Balances
    • -
  • Get Account Settings
    • -
  • Update Account Settings
    • -
    -
  • Prepare Payment
    • -
  • Submit Payment
    • -
  • Confirm Payment
    • -
  • Get Payment History
    • -
    -
  • Place Order
    • -
  • Cancel Order
    • -
  • Get Account Orders
    • -
  • Get Order Book
    • -
    -
  • Get Trustlines
    • -
  • Grant Trustline
    • -
    -
  • Check Notifications
    • -
    -
  • Check Connection
    • -
  • Get Server Status
    • -
    -
  • Retrieve Ripple Transaction
    • -
  • Retrieve Transaction Fee
    • -
  • Generate UUID
    • -
-
-
-
-

REST Request

- +
+
+
-

-

-
Invalid JSON
- -
-

https://api.ripple.com

+
+
    +
  • Generate Wallet
    • +
  • Get Account Balances
    • +
  • Get Account Settings
    • +
  • Update Account Settings
    • +
    +
  • Prepare Payment
    • +
  • Submit Payment
    • +
  • Confirm Payment
    • +
  • Get Payment History
    • +
    +
  • Place Order
    • +
  • Cancel Order
    • +
  • Get Account Orders
    • +
  • Get Order Book
    • +
    +
  • Get Trustlines
    • +
  • Grant Trustline
    • +
    +
  • Check Notifications
    • +
    +
  • Check Connection
    • +
  • Get Server Status
    • +
    +
  • Retrieve Ripple Transaction
    • +
  • Retrieve Transaction Fee
    • +
  • Generate UUID
    • +
+
+
+
+

REST Request

+ +
+

+

+
Invalid JSON
+
+

https://api.ripple.com

+
+
+
+
Send request
+
+
+
+

Response

+
+ + +
+
+
+
+
+
-
-
-
Send request
-
-
-
-

Response

-
- - -
-
-
-
-
-
-
-
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
+
+
+ - - - - - - - - + + + + + + + diff --git a/ripple-api-tool.html b/ripple-api-tool.html index ef3709f53a..df70e94c1b 100644 --- a/ripple-api-tool.html +++ b/ripple-api-tool.html @@ -1,35 +1,36 @@ - - + + - - - + + + - Ripple Developer Portal: Websocket API Tool + WebSocket API Tool - Ripple Developer Portal - - - + + + - - - - - - + + + + + - - - - - - - - + + + + + + + + + + - + -
-
+
+
Offline
-
    -
  • server_info
    • -
  • server_state
    • -
  • ping
    • -
    -
  • subscribe
    • -
  • unsubscribe
    • -
    -
  • ledger
    • -
  • ledger_closed
    • -
  • ledger_current
    • -
  • ledger_entry
    • -
    -
  • account_info
    • -
  • account_lines
    • -
  • account_offers
    • -
  • account_tx
    • -
    -
  • transaction_entry
    • -
  • tx
    • -
  • tx_history
    • -
    -
  • sign
    • -
  • submit
    • -
    -
  • ripple_path_find
    • -
  • path_find
    • -
  • book_offers
    • -
-
-
-
-

WebSocket Request

- -
-
-
-
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
+
+
+
- + @@ -197,7 +212,5 @@ - - diff --git a/ripple-rest.html b/ripple-rest.html index 3cc75005ac..8bd6b4e01c 100644 --- a/ripple-rest.html +++ b/ripple-rest.html @@ -1,58 +1,63 @@ - - + + - - - + + + - Ripple Developer Portal: Ripple-REST + Ripple-REST - Ripple Developer Portal - - - + + + - - - - - - - - + + - - - + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + -
-
-
+
+
+
+
+
+
+
+
-
-
-
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
+
+ diff --git a/rippled-apis.html b/rippled-apis.html index a18b8dc875..4c4b8528b0 100644 --- a/rippled-apis.html +++ b/rippled-apis.html @@ -1,74 +1,63 @@ - + - - - + + + - Ripple Developer Portal: rippled + rippled - Ripple Developer Portal - - - - - - - - - - - - + + + - - - - - - - + + + + + + - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - -
-
- -
- - - - - - -
+
+
+
+
+
+
+
+
-
- - - - - - - - - - -
-
-
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
+
- - - - + + + diff --git a/terms-conditions.html b/terms-conditions.html deleted file mode 100644 index 63f57a04e3..0000000000 --- a/terms-conditions.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - Ripple Dev Portal Resources - - - - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
-

- Terms and Conditions -

-

- These terms and conditions (“Terms”) apply to my (or if I am representing a company, me and my company; collectively, “I,” “My,” “Our,” “We,” “You” or “Your”) and Our use of the Ripple trademarks, logos and trade dress (the “RIPPLE Branding”), which I understand are owned by Ripple Labs, Inc. (“Ripple Labs”). I understand that by agreeing to these terms, I may only use the RIPPLE Branding as permitted. -

-

- We agree: -

-

- I understand that I may only use the RIPPLE Branding in conjunction with websites that utilize the Ripple software, and only in a manner - consistent with Ripple Labs’ RIPPLE Brand Guidelines. In addition, I understand that my use of the RIPPLE Branding must be accompanied - by attribution appearing at the bottom of the page, as follows: “RIPPLE is a trademark of Ripple Labs, Inc. Use of these trademarks is not - intended to constitute or imply endorsement or sponsorship by or affiliation with Ripple Labs, Inc.” I understand that if I discontinue use of - the Ripple software, I shall also discontinue using the RIPPLE Branding. -

-

- I understand I may only use the RIPPLE Branding in conjunction with legitimate and lawful business, but that I may not use the RIPPLE - Branding in a manner that might cause harm to Ripple Labs or its reputation or goodwill. We will not, under any circumstances, use the - RIPPLE Branding in connection with any unlawful activity. I understand that I may not use the RIPPLE Branding in connection with software - similar to the Ripple software. -

-

- I understand that I may not use the RIPPLE Branding on any website that duplicates the look and feel of Ripple Labs’ website, and that I may - not use the RIPPLE Branding in any metatags or any other “hidden text” on a website. - I understand that the RIPPLE Branding is the property of Ripple Labs, and that Ripple Labs reserves all rights not expressly granted here. - I understand that I may not adopt or use any logos or trademarks that are confusingly similar to any of the trademarks, trade dress or logos - associated with the RIPPLE Branding. -

-

- I understand that Ripple Labs reserves the right to terminate My use of the RIPPLE Branding. This includes, for example, if Ripple Labs, in its - opinion, believes that the RIPPLE Branding is being used improperly or for an improper purpose. I agree that upon receipt of a request - from Ripple Labs that I discontinue use of the RIPPLE Branding, I will comply with the request. - Our lawyers also insist that we include the following terms: -

-

- These Terms and Your use of the RIPPLE Branding shall be governed by and construed in accordance with the laws of California, without - resort to its conflict of law provisions. You agree that any action at law or in equity arising out of or relating to these Terms not subject to - arbitration (as set forth below), will be filed only in the state and federal courts located in San Francisco, California and You hereby irrevocably - and unconditionally consent and submit to the exclusive jurisdiction of such courts over any suit, action or proceeding. - PLEASE READ THE FOLLOWING PARAGRAPH CAREFULLY BECAUSE IT REQUIRES YOU TO ARBITRATE DISPUTES WITH RIPPLE LABS AND IT - LIMITS THE MANNER IN WHICH YOU CAN SEEK RELIEF. -

-

- You and Ripple Labs agree to arbitrate any dispute arising from these Terms or relating to Your use of the RIPPLE branding, except that you - and Ripple Labs are not required to arbitrate any dispute in which either party seeks equitable or other relief for the alleged unlawful use of - copyrights, trademarks, trade names, logos, trade secrets or patents. ARBITRATION PREVENTS YOU FROM SUING IN COURT OR FROM - HAVING A JURY TRIAL. You and Ripple Labs agree that each will notify each other of any dispute within thirty (30) days of when it arises, that - You will attempt informal resolution prior to any demand for arbitration, that any arbitration will occur in San Francisco, California, and that - arbitration will be conducted confidentially by a single arbitrator in accordance with the rules of JAMS. You and Ripple Labs also agree that - the state or federal courts in San Francisco, California have exclusive jurisdiction over any appeals of an arbitration award and over any suit - between the parties not subject to arbitration. The arbitrator has the authority to grant any remedy that would otherwise be available in - court. -

-
-
-
-
- -
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
-
-
-
- -
- - - - - - diff --git a/tool/buttonize.py b/tool/buttonize.py new file mode 100644 index 0000000000..5eb9855931 --- /dev/null +++ b/tool/buttonize.py @@ -0,0 +1,25 @@ +#!/usr/bin/env python + +""" +Pandoc filter to make output more like Flatdoc's parser: +* convert links ending in > to button-class links without the > +* convert underscores to dashes in header IDs +""" + +from pandocfilters import toJSONFilter, Link, Str, RawInline, Header, stringify + +def buttonize(key, value, format, meta): + if key == 'Link': + inlines, (href, title) = value + linktext = stringify(inlines).strip() + if (format == "html" or format == "html5") and linktext[-1] == ">": + html = "%s" % (title, href, linktext[:-1]) + newlink = RawInline("html", html) + return newlink + elif key == 'Header': + level, (identifier, classes, kv), inlines = value + identifier = identifier.replace("_","-") + return Header(level, (identifier, classes, kv), inlines) + +if __name__ == "__main__": + toJSONFilter(buttonize) diff --git a/tool/pages.json b/tool/pages.json new file mode 100644 index 0000000000..b87a28bca5 --- /dev/null +++ b/tool/pages.json @@ -0,0 +1,63 @@ +[ + { + "name": "rippled", + "md":"rippled.md", + "html":"rippled-apis.html" + }, + { + "name": "Ripple-REST", + "md": "ripplerest_api.md", + "html": "ripple-rest.html" + }, + { + "name": "Gatewayd", + "md":"gatewayd.md", + "html":"gatewayd.html" + }, + { + "name": "Transactions", + "md":"tx_format.md", + "html":"transactions.html" + }, + { + "name": "Reliable Transaction Submission", + "md":"reliable_tx.md", + "html":"reliable_tx.html" + }, + { + "name": "Gateway Guide", + "md":"exchange_to_gateway.md", + "html":"gateway_guide.html" + }, + { + "name": "Historical Data API", + "md": "historical_data.md", + "html": "historical_data.html" + }, + { + "name": "Gateway Services", + "md":"gateway_services_spec.md", + "html":"gateway_services.html" + }, + { + "name": "Whitepapers", + "md":"whitepapers.md", + "html":"whitepapers.html" + }, + { + "name": "Overview", + "template":"template-index.html", + "html": "index.html" + }, + { + "name": "Ripple-REST API Tool", + "template":"template-rest-api-tool.html", + "html": "rest-api-tool.html" + }, + { + "name": "WebSocket API Tool", + "template":"template-ripple-api-tool.html", + "html": "ripple-api-tool.html" + } +] + diff --git a/tool/parse_pages.py b/tool/parse_pages.py new file mode 100644 index 0000000000..3e3a1172e9 --- /dev/null +++ b/tool/parse_pages.py @@ -0,0 +1,100 @@ +#!/usr/bin/env python3 + +################################################################################ +# ripple-dev-portal doc parser +# +# Generate the html for all the Ripple Dev Portal files from a template +# Optionally pre-compile them to HTML (using pandoc & a custom filter) +################################################################################ + +from jinja2 import Environment, FileSystemLoader +import json +import subprocess +import os +import sys + +DOC_TEMPLATE_FILE = "template-doc.html" +PAGE_MANIFEST_FILE = "pages.json" +BUILD_PATH = ".." +CONTENT_PATH = "../content" +BUTTONIZE_FILTER = "buttonize.py" + +def render_pages(precompiled): + print("reading page manifest...") + with open(PAGE_MANIFEST_FILE) as f: + pages = json.load(f) + print("done") + + env = Environment(loader=FileSystemLoader(os.path.curdir)) + env.lstrip_blocks = True + env.trim_blocks = True + + for currentpage in pages: + + if "md" in currentpage: + # Documentation file + + print("reading template file...") + +# with open(DOC_TEMPLATE_FILE) as f: +# template_text = f.read() +# doc_template = Template(template_text) + doc_template = env.get_template(DOC_TEMPLATE_FILE) + print("done") + + + if precompiled: + filein = os.path.join(CONTENT_PATH, currentpage["md"]) + args = ['pandoc', filein, '-F', BUTTONIZE_FILTER, '-t', 'html'] + print("compiling: running ", " ".join(args),"...") + pandoc_html = subprocess.check_output(args, universal_newlines=True) + print("done") + + print("rendering page",currentpage,"...") + out_html = doc_template.render(currentpage=currentpage, pages=pages, + content=pandoc_html, precompiled=precompiled) + print("done") + + else: + print("compiling skipped") + + print("rendering page",currentpage,"...") + out_html = doc_template.render(currentpage=currentpage, pages=pages, + content="", precompiled=precompiled) + print("done") + + else: + # Not a documentation page + print("reading template file...") +# with open(currentpage["template"]) as f: +# template_text = f.read() +# template = Template(template_text) + template = env.get_template(currentpage["template"]) + print("done") + + + print("rendering page",currentpage,"...") + out_html = template.render(currentpage=currentpage, pages=pages) + print("done") + + + fileout = os.path.join(BUILD_PATH, currentpage["html"]) + if (not os.path.isdir(BUILD_PATH)): + print("creating build folder",BUILD_PATH) + os.makedirs(BUILD_PATH) + with open(fileout, "w") as f: + print("writing to file:",fileout,"...") + f.write(out_html) + print("done") + +if __name__ == "__main__": + if len(sys.argv) > 2: + exit("usage: %s [compile]" % sys.argv[0]) + elif len(sys.argv) <= 1: + render_pages(False) + elif sys.argv[1].lower() == "true": + render_pages(True) + elif sys.argv[1].lower() == "false": + render_pages(False) + else: + exit("argument 1 must be 'true' or 'false'") diff --git a/tool/template-base.html b/tool/template-base.html new file mode 100644 index 0000000000..b9db7e83c4 --- /dev/null +++ b/tool/template-base.html @@ -0,0 +1,134 @@ + + + + + + + + {{ currentpage.name }} - Ripple Developer Portal + + + + + + + + + + + + + {% block head %} + + {% endblock %} + + + + + + + + + + + + + +
+ {% block contentroot %}{% endblock %} +
+ +{% block endbody %}{% endblock %} + + + diff --git a/tool/template-doc.html b/tool/template-doc.html new file mode 100644 index 0000000000..982e03500e --- /dev/null +++ b/tool/template-doc.html @@ -0,0 +1,65 @@ +{% extends "template-base.html" %} +{% block head %} + + + + + + + + + + + + {% if precompiled %} + + + {% else %} + + + + + {% endif %} + + + +{% endblock %} + +{% block bodyattrs %} role='flatdoc' class='no-literate'{% endblock %} + +{% block contentroot %} +
+
+
+ {% if precompiled %} + + + {% endif %} +
+
+
+ {% if precompiled %} + {{ content }} + {% endif %} +
+
+{% endblock %} + diff --git a/tool/template-index.html b/tool/template-index.html new file mode 100644 index 0000000000..887dd8b867 --- /dev/null +++ b/tool/template-index.html @@ -0,0 +1,137 @@ +{% extends "template-base.html" %} +{% block head %} + + + + + + + + + + + +{% endblock %} + +{% block contentroot %} + + + +
+
+
+
+
+ +
+
+

Build on the world's first protocol for value exchange

+

Ripple is a protocol for making financial transactions worldwide, with no central authority responsible for managing it. Anyone can run a server, connect to the network, and start doing business. Get started by submitting API calls to our public servers now.

+ +

+
+
+
+
+
+ + + +
+
+ + + +
Applications
+
+

Ripple Trade

+

The official open-source web client to Ripple.

+ +
+
+
+

Ripple Charts

+

Live charts showing trading metrics and activity.

+ +
+
+
+

Ripple Graph

+

Interactive graph visualization of the Ripple ledger.

+ +
+ + + + +
Middleware
+
+

Gatewayd

+

Framework software for building a gateway—just add the connections to your payment system.

+ +
+
+
+

Ripple REST

+

Easily connect with a rippled server using REST: check balances, set trust lines, and more.

+ +
+
+
+

Ripple Lib

+

A JavaScript API for interacting with rippled.

+ +
+ + +
Core Network
+
+

rippled

+

The core server that makes the Ripple network possible.

+ +
+ +
+
+ +{% endblock %} diff --git a/tool/template-rest-api-tool.html b/tool/template-rest-api-tool.html new file mode 100644 index 0000000000..8df2011bfe --- /dev/null +++ b/tool/template-rest-api-tool.html @@ -0,0 +1,81 @@ +{% extends "template-base.html" %} +{% block contentroot %} +
+
+
+
+
    +
  • Generate Wallet
    • +
  • Get Account Balances
    • +
  • Get Account Settings
    • +
  • Update Account Settings
    • +
    +
  • Prepare Payment
    • +
  • Submit Payment
    • +
  • Confirm Payment
    • +
  • Get Payment History
    • +
    +
  • Place Order
    • +
  • Cancel Order
    • +
  • Get Account Orders
    • +
  • Get Order Book
    • +
    +
  • Get Trustlines
    • +
  • Grant Trustline
    • +
    +
  • Check Notifications
    • +
    +
  • Check Connection
    • +
  • Get Server Status
    • +
    +
  • Retrieve Ripple Transaction
    • +
  • Retrieve Transaction Fee
    • +
  • Generate UUID
    • +
+
+
+
+

REST Request

+ +
+

+

+
Invalid JSON
+
+

https://api.ripple.com

+
+
+
+
Send request
+
+
+
+

Response

+
+ + +
+
+
+
+
+
+
+
+
+{% endblock %} +{% block endbody %} + + + + + + + + + +{% endblock %} + diff --git a/tool/template-ripple-api-tool.html b/tool/template-ripple-api-tool.html new file mode 100644 index 0000000000..00b66cef9f --- /dev/null +++ b/tool/template-ripple-api-tool.html @@ -0,0 +1,86 @@ +{% extends "template-base.html" %} +{% block contentroot %} +
+
Offline
+
+
+
    +
  • server_info
    • +
  • server_state
    • +
  • ping
    • +
    +
  • subscribe
    • +
  • unsubscribe
    • +
    +
  • ledger
    • +
  • ledger_closed
    • +
  • ledger_current
    • +
  • ledger_entry
    • +
    +
  • account_info
    • +
  • account_lines
    • +
  • account_offers
    • +
  • account_tx
    • +
    +
  • transaction_entry
    • +
  • tx
    • +
  • tx_history
    • +
    +
  • sign
    • +
  • submit
    • +
    +
  • ripple_path_find
    • +
  • path_find
    • +
  • book_offers
    • +
+
+
+
+

WebSocket Request

+ +
+

server_info

+

+
Invalid JSON
+

JSON

+
+
+
Send request
+
+
+
+

Response

+
+ +
+

+
+
+
+

Stream output

+
    +
  • show
    • +
  • pause
    • +
+

+
+
+
+
+
+
+{% endblock %} + +{% block endbody %} + + + + + + + +{% endblock %} + diff --git a/transactions.html b/transactions.html index ac5677c2ba..7862aecfe3 100644 --- a/transactions.html +++ b/transactions.html @@ -1,70 +1,63 @@ - + - - - + + + - Ripple Developer Portal: Transactions + Transactions - Ripple Developer Portal - - - - - - - - - - - - + + + - - - + + - - - - - - - - - - - + + + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + - + -
-
-
+
+
+
+
+
+
+
+
-
- -
-
-
-
-

-

-
- - -
-
- - - -
-
- - - -
-
- - -
+
+
+ - diff --git a/vendor/flatdoc/v/0.8.0/theme-white/style.css b/vendor/flatdoc/v/0.8.0/theme-white/style.css index 63234c07c3..a55c8682de 100644 --- a/vendor/flatdoc/v/0.8.0/theme-white/style.css +++ b/vendor/flatdoc/v/0.8.0/theme-white/style.css @@ -549,7 +549,7 @@ body.no-literate .content pre > code:hover::-webkit-scrollbar-thumb { padding-right: 0; } } -.header { +/*.header { background: #f3f6fb; text-shadow: 0 1px 0 rgba(255,255,255,0.5); border-bottom: solid 1px #dfe2e7; @@ -601,7 +601,7 @@ body.no-literate .content pre > code:hover::-webkit-scrollbar-thumb { } .header li a:hover { color: #3a3a44; -} +}*/ @media (min-width: 480px) /* Tablet & Desktop */ { .header h1 { float: left; diff --git a/whitepapers.html b/whitepapers.html new file mode 100644 index 0000000000..db1dae091f --- /dev/null +++ b/whitepapers.html @@ -0,0 +1,172 @@ + + + + + + + + Whitepapers - Ripple Developer Portal + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+
+ + +