Browse Source

add syntax highlighting in markdown

master
Nicolas Massé 8 years ago
parent
commit
0a6896ed6a
  1. 14
      README.md

14
README.md

@ -33,7 +33,7 @@ feature is doomed to failure. The only example that this implementation
can propose is a sample SOAP message with question marks in each field to can propose is a sample SOAP message with question marks in each field to
fill-in. fill-in.
``` ```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:acme="http://www.acme.com/"> xmlns:acme="http://www.acme.com/">
<soapenv:Header/> <soapenv:Header/>
@ -63,14 +63,14 @@ the documentation and can try it out directly from the documentation page.
Following this philosophy, the previous example would look like this: Following this philosophy, the previous example would look like this:
_To do this, you have to pass the `foo` field with bla bla bla. Try it by yourself:_ _To do this, you have to pass the `foo` field with bla bla bla. Try it by yourself:_
``` ```xml
<acme:doThisAndThat xmlns:acme="http://www.acme.com/"> <acme:doThisAndThat xmlns:acme="http://www.acme.com/">
<acme:foo>123456</gs:foo> <acme:foo>123456</gs:foo>
</acme:doThisAndThat> </acme:doThisAndThat>
``` ```
_To do this, you have to pass the `bar` field with bla bla bla. Try it by yourself:_ _To do this, you have to pass the `bar` field with bla bla bla. Try it by yourself:_
``` ```xml
<acme:doThisAndThat xmlns:acme="http://www.acme.com/"> <acme:doThisAndThat xmlns:acme="http://www.acme.com/">
<acme:bar>ABCDEF</gs:bar> <acme:bar>ABCDEF</gs:bar>
</acme:doThisAndThat> </acme:doThisAndThat>
@ -105,7 +105,7 @@ Then, create a new page to hold the documentation of your SOAP Service with the
- Handler: *Leave empty* - Handler: *Leave empty*
In the content, make sure to have at the top of your page: In the content, make sure to have at the top of your page:
``` ```html
<link rel="stylesheet" type="text/css" href="/css/soapui.css"> <link rel="stylesheet" type="text/css" href="/css/soapui.css">
<script type='text/javascript' src='/javascripts/jquery.soap.js'></script> <script type='text/javascript' src='/javascripts/jquery.soap.js'></script>
<script type='text/javascript' src='/javascripts/vkbeautify.js'></script> <script type='text/javascript' src='/javascripts/vkbeautify.js'></script>
@ -125,7 +125,7 @@ In the content, make sure to have at the top of your page:
``` ```
And then write your documentation as usual: And then write your documentation as usual:
``` ```html
<h2>Description of our SOAP service</h2> <h2>Description of our SOAP service</h2>
blablabla blablabla
<h2>The getCountry method</h2> <h2>The getCountry method</h2>
@ -133,7 +133,7 @@ Here is what does the getCountry method. Blablabla.
``` ```
When you want to insert an example, write: When you want to insert an example, write:
``` ```html
<div class="soapui"> <div class="soapui">
<soap-action>http://acme.com/getCountry</soap-action> <soap-action>http://acme.com/getCountry</soap-action>
<soap-body> <soap-body>
@ -165,7 +165,7 @@ git submodule update
Then, modify the `index.html` page to point to your sample SOAP service. Then, modify the `index.html` page to point to your sample SOAP service.
You can also provide an API Key if you need one. You can also provide an API Key if you need one.
``` ```js
$.soapui(e, { $.soapui(e, {
url: 'http://api.acme.test/ws', url: 'http://api.acme.test/ws',
HTTPHeaders: { "user-key": "<your user-key here>" }, HTTPHeaders: { "user-key": "<your user-key here>" },

Loading…
Cancel
Save