https://github.com/easybird/json-to-frontmatter-markdown

Transform json to a markdown file with frontmatter and body
https://github.com/easybird/json-to-frontmatter-markdown

frontmatter json markdown nodejs

Last synced: 17 days ago
JSON representation

Transform json to a markdown file with frontmatter and body

• Host: GitHub
• URL: https://github.com/easybird/json-to-frontmatter-markdown
• Owner: easybird
• License: mit
• Created: 2018-04-04T10:47:45.000Z (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2018-04-09T10:22:57.000Z (over 6 years ago)
• Last Synced: 2024-10-01T18:46:09.411Z (about 1 month ago)
• Topics: frontmatter, json, markdown, nodejs
• Language: JavaScript
• Size: 122 KB
• Stars: 16
• Watchers: 1
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# json-to-frontmatter-markdown

This library has only one feature:

Transform a javascript object to markdown with frontmatter, and write it to a markdown file on a specified location.

-----

The following request, will result in the below markdown file on location /Users/user/path/to/dir/fileName.md:

```javascript

  transformAndWriteToFile({

    frontmatterMarkdown: {

      frontMatter: [

        { var1: 'this is a string'},

        { var2: ['this is an array', 'element2']},

        { obj1: {

          var3: "var3"

        }}

      ],

      body: `

        # h1 Heading 8-)

        ## h2 Heading

        ### h3 Heading

        #### h4 Heading

        ##### h5 Heading

        ###### h6 Heading

        `

      },

      path: '/Users/user/path/to/dir',

      fileName: 'fileName.md'

    })

```  

Result:

```markdown

---

var1: "this is a string"

var2: ["this is an array","element2"]

obj1:

  var3: "var3"

---

# h1 Heading 8-)

## h2 Heading

### h3 Heading

#### h4 Heading

##### h5 Heading

###### h6 Heading

```

----

If you have a feature request or issues, don't hesitate to log an issue.🙏