Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tim-hub/meta-marked-2020
Simplese markdown + yaml metadata processor.
https://github.com/tim-hub/meta-marked-2020
hexo markdown metadata static-site-generator yaml
Last synced: about 2 months ago
JSON representation
Simplese markdown + yaml metadata processor.
- Host: GitHub
- URL: https://github.com/tim-hub/meta-marked-2020
- Owner: tim-hub
- License: mit
- Created: 2020-01-10T08:09:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-26T14:44:44.000Z (over 3 years ago)
- Last Synced: 2024-05-01T14:46:44.740Z (9 months ago)
- Topics: hexo, markdown, metadata, static-site-generator, yaml
- Language: JavaScript
- Homepage:
- Size: 71.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# meta-marked-2020
[](https://codecov.io/gh/tim-hub/meta-marked-2020) [](https://renovatebot.com)
**The [marked](http://github.com/chjj/marked) markdown processor for Node.js with support for [YAML](http://yaml.org/) metadata**
This is a fork of [j201/meta-marked](https://github.com/j201/meta-marked), the upstream is not maintained.
# about
## why meta-marked-2020
- updated dependency
- handle hexo markdown files (in markdown hexo generated, there is no `---` at beginning of file)
## original idea
Just a quick extension I needed for processing markdown in Node. Props to Christopher Jeffrey for his excellent markdown processor 'marked'.
The `meta-marked-2020` function behaves exactly the same as [`marked`](http://github.com/chjj/marked#usage), except for the following:
- Instead of returning a parsed string, `meta-marked` returns an object with the following properties:
- `meta` contains the metadata object or `null` if metadata isn't found
- `html` contains the parsed HTML
- `markdown` contains the text of the markdown section of the string
- `metaMarked.noMeta` is a reference to the `marked` function, so it can be used to avoid parsing metadata.
In order to include metadata in a document, insert YAML at the top of the document surrounded by `---` and `...`. Note that if the given string doesn't start with `---`, it will not be interpreted as having metadata.
# how to
```javascript
const metaMarked = require("meta-marked-2020");
const obj = new metaMarked("---yaml meta --- markdown");
```
## Example
```
---
Title: My awesome markdown file
Author: Me
Scripts:
- js/doStuff.js
- js/doMoreStuff.js
...
##Header
Regular text and stuff goes here.
```
You can also use the approach below, which will result in a very nice data table at the top of your markdown when viewing the file GitHub:
```
---
Title: My awesome markdown file
Author: Me
Scripts:
- js/doStuff.js
- js/doMoreStuff.js
---
##Header
Regular text and stuff goes here.
```
Both of the above will result in the following output:
```
{
"meta": {
"Title": "My awesome markdown file",
"Author": "Me",
"Scripts": [
"js/doStuff.js",
"js/doMoreStuff.js"
]
},
"html": "
Header
\nRegular text and stuff goes here.
\n",
"markdown": "\n\n##Header\nRegular text and stuff goes here."
}
```
###Testing
```
npm test
```
---
Licensed under the MIT License.