Add table of contents to docs

This commit is contained in:
Chris Clark
2015-11-19 10:37:08 -08:00
parent f7f2de291f
commit 5fb8d9214f
6 changed files with 73 additions and 8 deletions

View File

@@ -1,5 +1,62 @@
RippleAPI Reference
-------------------
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
# RippleAPI Reference
- [Introduction](#introduction)
- [Boilerplate](#boilerplate)
- [Basic Types](#basic-types)
- [Ripple Address](#ripple-address)
- [Account Sequence Number](#account-sequence-number)
- [Currency](#currency)
- [Value](#value)
- [Amount](#amount)
- [Transaction Overview](#transaction-overview)
- [Transaction Types](#transaction-types)
- [Transaction Flow](#transaction-flow)
- [Transaction Fees](#transaction-fees)
- [Transaction Instructions](#transaction-instructions)
- [Transaction ID](#transaction-id)
- [Transaction Specifications](#transaction-specifications)
- [Payment](#payment)
- [Trustline](#trustline)
- [Order](#order)
- [Order Cancellation](#order-cancellation)
- [Settings](#settings)
- [Suspended Payment Creation](#suspended-payment-creation)
- [Suspended Payment Cancellation](#suspended-payment-cancellation)
- [Suspended Payment Execution](#suspended-payment-execution)
- [API Methods](#api-methods)
- [connect](#connect)
- [disconnect](#disconnect)
- [isConnected](#isconnected)
- [getServerInfo](#getserverinfo)
- [getFee](#getfee)
- [getLedgerVersion](#getledgerversion)
- [getTransaction](#gettransaction)
- [getTransactions](#gettransactions)
- [getTrustlines](#gettrustlines)
- [getBalances](#getbalances)
- [getBalanceSheet](#getbalancesheet)
- [getPaths](#getpaths)
- [getOrders](#getorders)
- [getOrderbook](#getorderbook)
- [getSettings](#getsettings)
- [getAccountInfo](#getaccountinfo)
- [getLedger](#getledger)
- [preparePayment](#preparepayment)
- [prepareTrustline](#preparetrustline)
- [prepareOrder](#prepareorder)
- [prepareOrderCancellation](#prepareordercancellation)
- [prepareSettings](#preparesettings)
- [prepareSuspendedPaymentCreation](#preparesuspendedpaymentcreation)
- [prepareSuspendedPaymentCancellation](#preparesuspendedpaymentcancellation)
- [prepareSuspendedPaymentExecution](#preparesuspendedpaymentexecution)
- [sign](#sign)
- [submit](#submit)
- [generateAddress](#generateaddress)
- [computeLedgerHash](#computeledgerhash)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
# Introduction

View File

@@ -1,6 +1,3 @@
RippleAPI Reference
-------------------
<% include introduction.md.ejs %>
<% include boilerplate.md.ejs %>
<% include basictypes.md.ejs %>