mirrors/bbob
2
0
Fork 0
mirror of https://github.com/tenrok/BBob.git synced 2026-06-17 19:21:20 +03:00
Code Activity

chore(parser): update readme

Browse Source
This commit is contained in:
Nikolay Kostyurin
2018-07-20 23:36:43 +02:00
committed by GitHub
parent 6c97f04430
commit ade8424ceb
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/bbob-parser/README.md
+4 -3
View File
@@ -1,7 +1,8 @@
# @bbob/parser # @bbob/parser
[![install size](https://packagephobia.now.sh/badge?p=@bbob/parser)](https://packagephobia.now.sh/result?p=@bbob/parser) [![Known Vulnerabilities](https://snyk.io/test/github/JiLiZART/bbob/badge.svg?targetFile=packages%2Fbbob-parser%2Fpackage.json)](https://snyk.io/test/github/JiLiZART/bbob?targetFile=packages%2Fbbob-parser%2Fpackage.json) [![install size](https://packagephobia.now.sh/badge?p=@bbob/parser)](https://packagephobia.now.sh/result?p=@bbob/parser) [![Known Vulnerabilities](https://snyk.io/test/github/JiLiZART/bbob/badge.svg?targetFile=packages%2Fbbob-parser%2Fpackage.json)](https://snyk.io/test/github/JiLiZART/bbob?targetFile=packages%2Fbbob-parser%2Fpackage.json)
Parses BBCode and returns AST Tree valid for use in [posthtml-render](https://github.com/posthtml/posthtml-render) Parses BBCode and returns AST Tree
Valid for use with [posthtml-render](https://github.com/posthtml/posthtml-render)
## Usage ## Usage
@@ -12,7 +13,7 @@ const options = {
onlyAllowTags: ['url', 'h'], onlyAllowTags: ['url', 'h'],
onError: (err) => console.warn(err.message, err.lineNumber, err.columnNumber) onError: (err) => console.warn(err.message, err.lineNumber, err.columnNumber)
} }
const ast = parse('[url=https://github.com/JiLiZART/bbob/tree/master/packages/bbob-parser]hello world![/url]', options) const ast = parse('[url=https://github.com]hello world![/url]', options)
``` ```
## Results ## Results
@@ -22,7 +23,7 @@ const ast = parse('[url=https://github.com/JiLiZART/bbob/tree/master/packages/bb
{ {
"tag": "url", "tag": "url",
"attrs": { "attrs": {
"url": "https://github.com/JiLiZART/bbob/tree/master/packages/bbob-parser" "url": "https://github.com"
}, },
"content": ["hello", " ", "world!"] "content": ["hello", " ", "world!"]
} }