64 lines
2.4 KiB
Markdown
64 lines
2.4 KiB
Markdown
# @pushrocks/smartfm
|
|
frontmatter done right
|
|
|
|
> Please consider following us on https://beta.news/lossless to subscribe to infos on changes and updates.
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartfm)
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartfm)
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smartfm)
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartfm/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/smartfm/commits/master)
|
|
[](https://gitlab.com/pushrocks/smartfm/commits/master)
|
|
[](https://www.npmjs.com/package/@pushrocks/smartfm)
|
|
[](https://snyk.io/test/npm/@pushrocks/smartfm)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://prettier.io/)
|
|
|
|
## Usage
|
|
|
|
We recommend TypeScript for best in class Intellisense.
|
|
|
|
```javascript
|
|
import * as smartfm from * smartfm
|
|
|
|
let markdownfile = `---
|
|
testKey: testValue
|
|
testKey2: testValue2
|
|
---
|
|
# some markdown`
|
|
|
|
// easy methods
|
|
let parsedData = smartfm.parse(markdownfile)
|
|
|
|
// parsedData will be object
|
|
/*
|
|
{
|
|
data: {
|
|
testKey: testValue,
|
|
testKey2: testValue2
|
|
},
|
|
content: '# some markdown',
|
|
orig: '---\ntestKey: testValue\ntestKey2: testValue2\n---\n# some markdown'
|
|
}
|
|
*/
|
|
|
|
let newFmString = smartfm.stringify('My awesome string', {testKey1: testValue1})
|
|
// newFmString will be '---\testKey1: testValue1\n---\nMyawesomeString'
|
|
|
|
# class Smartfm
|
|
let mySmartfm = new smartfm.Smartfm({
|
|
fmType: 'yaml' // can be yaml or json atm
|
|
})
|
|
```
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
|
|
[](https://maintainedby.lossless.com)
|