GitHub的问题导致我的README.rst错误地...?

时间:2014-03-25 06:35:50

标签: github

我有一个GitHub repo/branch,我正在尝试更新README.rst,但它并没有按照我所期望的方式格式化我所包含的项目符号列表。

除了我的用法部分,其他一切似乎都没问题,其中我有以下内容:

*****
Usage
*****

- Open the template file that corresponds to the API call you'd like to make.
    * Example: If we want to make a call to the RefundTransaction API we open up /templates/RefundTransaction.php

- You may leave the file here, or save this file to the location on your web server where you'd like this call to be made.
    * I like to save the files to a separate location and keep the ones included with the library as empty templates.
    * Note that you can also copy/paste the template code into your own file(s).

- Each template file includes PHP arrays for every parameter available to that particular API. Simply fill in the array parameters with your own dynamic (or static) data. This data may come from:
    * Session Variables
    * General Variables
    * Database Recordsets
    * Static Values
    * Etc.

- When you run the file you will get a $PayPalResult array that consists of all the response parameters from PayPal, original request parameters sent to PayPal, and raw request/response info for troubleshooting.
    * You may refer to the `PayPal API Reference Guide <https://developer.paypal.com/webapps/developer/docs/classic/api/>`_ for details about what response parameters you can expect to get back from any successful API request.
        + Example: When working with RefundTransaction, I can see that PayPal will return a REFUNDTRANSACTIONID, FEEREFUNDAMT, etc. As such, I know that those values will be included in $PayPalResult['REFUNDTRANSACTIONID'] and $PayPalResult['FEEREFUNDAMT'] respectively.

- If errors occur they will be available in $PayPalResult['ERRORS']

You may refer to this `overview video <http://www.angelleye.com/overview-of-php-class-library-for-paypal/>`_ of how to use the library, 
and there are also samples provided in the /samples directory as well as blank templates ready to use under /templates.

You may `contact me directly <http://www.angelleye.com/contact-us/>`_ if you need additional help getting started.  I offer 30 min of free training for using this library, 
which is generally plenty to get you up-and-running.

出于某种原因,当你在GitHub上看到它时,子弹列表的第一行是粗体和斜体,我不明白为什么。此外,它显示会话变量,通用变量等的子列表应该是所有相同的子列表。我不确定为什么它会在看到General Variables时掉进另一个子。

我非常感谢任何有关我在这里做错的信息。谢谢!

1 个答案:

答案 0 :(得分:0)

从.rst切换到.md,然后使用&#39; #&#39; for your headings

## Usage

-  Open the template file that corresponds to the API call you'd like to make.
     * Example