Compare commits
2 Commits
Author | SHA1 | Date | |
---|---|---|---|
92da6611c7 | |||
9288ed3d2c |
14
README.md
14
README.md
@ -1,5 +1,5 @@
|
|||||||
# smartfm
|
# smartfm
|
||||||
smartfm handles frontmatter of files
|
frontmatter done right
|
||||||
|
|
||||||
## Availabililty
|
## Availabililty
|
||||||
[](https://www.npmjs.com/package/smartfm)
|
[](https://www.npmjs.com/package/smartfm)
|
||||||
@ -17,20 +17,26 @@ smartfm handles frontmatter of files
|
|||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
[](http://standardjs.com/)
|
[](http://standardjs.com/)
|
||||||
|
|
||||||
## Usage
|
## What is frontMatter?
|
||||||
|
|
||||||
say you have the following markdown file:
|
say you have the following markdown file:
|
||||||
```markdown
|
```markdown
|
||||||
---
|
---
|
||||||
title: A really awesome article
|
title: A Really Awesome Article
|
||||||
date: 23-10-2020
|
date: 23-10-2020
|
||||||
type: feature
|
type: feature
|
||||||
---
|
---
|
||||||
# A Awesome Title
|
# An Awesome Title
|
||||||
The world is cool. And here is why
|
The world is cool. And here is why
|
||||||
* reason 1
|
* reason 1
|
||||||
* reason 2
|
* reason 2
|
||||||
```
|
```
|
||||||
|
The top part that is enclosed by `---` denotes frontmatter, usually written in yaml notation.
|
||||||
|
Frontmatter is not exclusive to markdown.
|
||||||
|
It can be used as prefix in any type of file when preprocessed with smartfm.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
We recommend TypeScript for best in class Intellisense.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import * as smartfm from * smartfm
|
import * as smartfm from * smartfm
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "smartfm",
|
"name": "smartfm",
|
||||||
"version": "1.0.1",
|
"version": "1.0.2",
|
||||||
"description": "frontmatter done right",
|
"description": "frontmatter done right",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist/index.d.ts",
|
||||||
|
Reference in New Issue
Block a user