doc: add example

yyz945947732 · Sep 26, 2023 · 2da385d · 2da385d
1 parent 450777e
commit 2da385d
Show file tree

Hide file tree

Showing 5 changed files with 88 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,8 @@ console.log(converted);
 // | Centro comercial Moctezuma | Francisco Chang | Mexico  |
 ```
 
+[OUTPUT](https://github.com/yyz945947732/tabletomd/tree/master/example/convertOutput.md)
+
 ### Remote (`convertUrl`)
 
 ```typescript
@@ -59,6 +61,8 @@ import { convertUrl } from 'tabletomd';
 const markdown = await convertUrl('https://www.npmjs.com/package/rc-table');
 ```
 
+[OUTPUT](https://github.com/yyz945947732/tabletomd/tree/master/example/convertUrlOutput.md)
+
 ## Credits
 
 The following node libraries make this utility super easy:

diff --git a/example/convertOutput.md b/example/convertOutput.md
@@ -0,0 +1,4 @@
+|          Company           |     Contact     | Country |
+|:---------------------------|:----------------|:--------|
+|    Alfreds Futterkiste     |  Maria Anders   | Germany |
+| Centro comercial Moctezuma | Francisco Chang | Mexico  |