Skip to content

Commit c7b2723

Browse files
IonicaBizauIonicaBizau
committed
Updated docs
1 parent 4d97394 commit c7b2723

6 files changed

Lines changed: 22 additions & 19 deletions

File tree

‎DOCUMENTATION.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@ Converts a JSON input to markdown.
1717
| `h6` | Heading 6 | The heading text as string. | `{ h6: "heading 6" }` |
1818
| `p` | Paragraphs | The paragraph text as string or array (multiple paragraphs). | `{ p: "Hello World"}` or multiple paragraphs: `{ p: ["Hello", "World"] }` |
1919
| `blockquote` | Blockquote | The blockquote as string or array (multiple blockquotes) | `{ blockquote: "Hello World"}` or multiple blockquotes: `{ blockquote: ["Hello", "World"] }` |
20-
| `img` | Image | An object or an array of objects containing the `title`, `source` and `alt` fields. | `{ img: { title: "My image title", source: "http://example.com/image.png", alt: "My image alt" } }` |
21-
| `ul` | Unordered list | An array of strings or lists representing the items. | `{ ul: ["item 1", "item 2"] }` |
22-
| `ol` | Ordered list | An array of strings or lists representing the items. | `{ ol: ["item 1", "item 2"] }` |
20+
| `img` | Image | An object or an array of objects containing the `title`, `source` and `alt` fields. | `{ img: { title: "My image title", source: "http://example.com/image.png", alt: "My image alt" } }` |
21+
| `ul` | Unordered list | An array of strings or lists representing the items. | `{ ul: ["item 1", "item 2"] }` |
22+
| `ol` | Ordered list | An array of strings or lists representing the items. | `{ ol: ["item 1", "item 2"] }` |
23+
| `hr` | Separator | None | `{ hr: "" }` |
2324
| `code` | Code block element | An object containing the `language` (`String`) and `content` (`Array` or `String`) fields. | `{ code: { "language": "html", "content": "<script src='dummy.js'></script>" } }` |
2425
| `table` | Table | An object containing the `headers` (`Array` of `String`s) and `rows` (`Array` of `Array`s or `Object`s). | `{ table: { headers: ["a", "b"], rows: [{ a: "col1", b: "col2" }] } }` or `{ table: { headers: ["a", "b"], rows: [["col1", "col2"]] } }` |
25-
| `link` | Link | An object containing the `title` and the `source` fields. | `{ title: 'hello', source: 'https://ionicabizau.net' }
26+
| `link` | Link | An object containing the `title` and the `source` fields. | `{ title: 'hello', source: 'https://ionicabizau.net' }` |
2627

2728
You can extend the `json2md.converters` object to support your custom types.
2829

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015-20 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
3+
Copyright (c) 2015-21 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,13 @@ Converts a JSON input to markdown.
192192
| `h6` | Heading 6 | The heading text as string. | `{ h6: "heading 6" }` |
193193
| `p` | Paragraphs | The paragraph text as string or array (multiple paragraphs). | `{ p: "Hello World"}` or multiple paragraphs: `{ p: ["Hello", "World"] }` |
194194
| `blockquote` | Blockquote | The blockquote as string or array (multiple blockquotes) | `{ blockquote: "Hello World"}` or multiple blockquotes: `{ blockquote: ["Hello", "World"] }` |
195-
| `img` | Image | An object or an array of objects containing the `title`, `source` and `alt` fields. | `{ img: { title: "My image title", source: "http://example.com/image.png", alt: "My image alt" } }` |
196-
| `ul` | Unordered list | An array of strings or lists representing the items. | `{ ul: ["item 1", "item 2"] }` |
197-
| `ol` | Ordered list | An array of strings or lists representing the items. | `{ ol: ["item 1", "item 2"] }` |
195+
| `img` | Image | An object or an array of objects containing the `title`, `source` and `alt` fields. | `{ img: { title: "My image title", source: "http://example.com/image.png", alt: "My image alt" } }` |
196+
| `ul` | Unordered list | An array of strings or lists representing the items. | `{ ul: ["item 1", "item 2"] }` |
197+
| `ol` | Ordered list | An array of strings or lists representing the items. | `{ ol: ["item 1", "item 2"] }` |
198+
| `hr` | Separator | None | `{ hr: "" }` |
198199
| `code` | Code block element | An object containing the `language` (`String`) and `content` (`Array` or `String`) fields. | `{ code: { "language": "html", "content": "<script src='dummy.js'></script>" } }` |
199200
| `table` | Table | An object containing the `headers` (`Array` of `String`s) and `rows` (`Array` of `Array`s or `Object`s). | `{ table: { headers: ["a", "b"], rows: [{ a: "col1", b: "col2" }] } }` or `{ table: { headers: ["a", "b"], rows: [["col1", "col2"]] } }` |
200-
| `link` | Link | An object containing the `title` and the `source` fields. | `{ title: 'hello', source: 'https://ionicabizau.net' }`
201+
| `link` | Link | An object containing the `title` and the `source` fields. | `{ title: 'hello', source: 'https://ionicabizau.net' }` |
201202

202203
You can extend the `json2md.converters` object to support your custom types.
203204

@@ -287,13 +288,13 @@ If you are using this library in one of your projects, add it in this list. :spa
287288

288289
- `@sidneys/releasenotes`
289290
- `@microfleet/schema2md`
290-
- `@best/github-integration`
291291
- `@cypress/schema-tools`
292+
- `@best/github-integration`
292293
- `lambda-docs-2md`
293294
- `jumia-travel-changelog`
294295
- `@cobalt-engine/change-logger`
295-
- `@best/store`
296296
- `uxcore-tools`
297+
- `@best/store`
297298
- `p2doc`
298299
- `pantheon_site_management`
299300
- `react-docgen-markdown`
@@ -324,17 +325,17 @@ If you are using this library in one of your projects, add it in this list. :spa
324325
- `parse-google-docs-json`
325326
- `node-red-contrib-json2md`
326327
- `dokuinjs`
327-
- `@feizheng/react-markdown-props`
328-
- `@e2y/bdd-dictionary-generator`
329-
- `@s-ui/changelog`
330328
- `lab-changelog`
331-
- `@jswork/react-markdown-props`
332-
- `@gracexwho/model-card-generator`
333329
- `@bwagener/gridsome-source-google-docs`
334330
- `asm-auto-deploy`
335331
- `type-graphql-to-md`
332+
- `@gracexwho/model-card-generator`
336333
- `gatsby-source-google-docs`
337-
- `dargstack_rgen`I am using this library to generate documentation for my projects, being integrated with [blah](https://github.com/IonicaBizau/node-blah).
334+
- `@e2y/bdd-dictionary-generator`
335+
- `@s-ui/changelog`
336+
- `dargstack_rgen`
337+
- `@feizheng/react-markdown-props`
338+
- `@jswork/react-markdown-props`I am using this library to generate documentation for my projects, being integrated with [blah](https://github.com/IonicaBizau/node-blah).
338339

339340

340341

‎lib/index.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ const converters = require("./converters")
2222
* | `img` | Image | An object or an array of objects containing the `title`, `source` and `alt` fields. | `{ img: { title: "My image title", source: "http://example.com/image.png", alt: "My image alt" } }` |
2323
* | `ul` | Unordered list | An array of strings or lists representing the items. | `{ ul: ["item 1", "item 2"] }` |
2424
* | `ol` | Ordered list | An array of strings or lists representing the items. | `{ ol: ["item 1", "item 2"] }` |
25+
* | `hr` | Separator | None | `{ hr: "" }` |
2526
* | `code` | Code block element | An object containing the `language` (`String`) and `content` (`Array` or `String`) fields. | `{ code: { "language": "html", "content": "<script src='dummy.js'></script>" } }` |
2627
* | `table` | Table | An object containing the `headers` (`Array` of `String`s) and `rows` (`Array` of `Array`s or `Object`s). | `{ table: { headers: ["a", "b"], rows: [{ a: "col1", b: "col2" }] } }` or `{ table: { headers: ["a", "b"], rows: [["col1", "col2"]] } }` |
2728
* | `link` | Link | An object containing the `title` and the `source` fields. | `{ title: 'hello', source: 'https://ionicabizau.net' }` |

‎package-lock.json‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@
6161
"bloggify.json",
6262
"bloggify/"
6363
]
64-
}
64+
}

0 commit comments

Comments
 (0)