Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

more read me changes for github

  • Loading branch information...
commit d978c3e95b383bc2f2caf0c52b1a9a7329cd88c0 1 parent a658773
@doug-martin authored
Showing with 12 additions and 8 deletions.
  1. +6 −6 README.md
  2. +6 −2 lib/index.js
View
12 README.md
@@ -50,17 +50,17 @@
<li>ignoreCode : ignore the parsed code in the output</li>
<li>includeDoc : include an external doc. External docs can be html or markdown.
Example
- ```javascript
- &#64;includeDoc [Title Of Doc] ../location/of_doc.md
-```
+
+<code>&#64;includeDoc [Title Of Doc] ../location/of_doc.md</code>
+
</li>
<li>projectName : document the projectName</li>
<li>github : url to github project</li>
<li>code : specifies a code block without needing an <code>example</code> tag
Example
- ```javascript
- &#123;&#64;code var test = "test"; &#125;
-```
+
+<code>&#123;&#64;code var test = "test"; &#125;</code>
+
</li>
<li>header : allows you to document a header that should appear before
View
8 lib/index.js
@@ -64,13 +64,17 @@
* <li>ignoreCode : ignore the parsed code in the output</li>
* <li>includeDoc : include an external doc. External docs can be html or markdown.
* Example
- * {@code &#64;includeDoc [Title Of Doc] ../location/of_doc.md}
+ *
+ * <code>&#64;includeDoc [Title Of Doc] ../location/of_doc.md</code>
+ *
* </li>
* <li>projectName : document the projectName</li>
* <li>github : url to github project</li>
* <li>code : specifies a code block without needing an <code>example</code> tag
* Example
- * {@code &#123;&#64;code var test = "test"; &#125;}
+ *
+ * <code>&#123;&#64;code var test = "test"; &#125;</code>
+ *
* </li>
*
* <li>header : allows you to document a header that should appear before
Please sign in to comment.
Something went wrong with that request. Please try again.