https://github.com/lukemorton/markedly

Turn a directory of Markdown into JSON for your blog
https://github.com/lukemorton/markedly

Last synced: 3 months ago
JSON representation

Turn a directory of Markdown into JSON for your blog

• Host: GitHub
• URL: https://github.com/lukemorton/markedly
• Owner: lukemorton
• License: mit
• Created: 2017-09-12T22:41:16.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T03:48:07.000Z (over 1 year ago)
• Last Synced: 2024-03-21T21:05:44.717Z (3 months ago)
• Language: JavaScript
• Size: 1.27 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - markedly

README

        
# Markedly

Turn a directory of Markdown files into JSON for your blog.

## Usage

To use markedly, first add it to your project:

```

npm install --save markedly

```

Now you can use the `markedly` command:

```

node_modules/.bin/markedly

```

By default markedly compiles a directory of markdown, by default it looks in  `posts/`, into a single `dist/posts/index.json` with file paths as keys. Below is an example of the JSON produced:

``` json

{

  "2017-01-17-lightweight-docker-images-for-go": {

    "title": "
Lightweight docker images for Go
\n",

    "plainTitle": "Lightweight docker images for Go",

    "intro": "
On building lightweight Docker images for Go applications.
\n",

    "publishedAt": "17th January 2017",

    "publishedAtISO": "2017-01-17T00:00:00.000+00:00",

    "content": "
On building lightweight Docker images for Go applications.
\n
In my last article I wrote about deploying Go apps to Now. I arrived at a solution that compiled a Go app inside a Docker container. This means that the Docker container needed to be built with all the dependencies necessary to compile Go code into something useful.
",

    "slug": "2017-01-17-lightweight-docker-images-for-go"

  }

}

```


You can also create lists of posts in your `package.json`:

``` json

{

  "markedly": {

    "lists": {

      "latestArticles": {

        "sort": "publishedAt",

        "reverse": true,

        "limit": 10

      }

    }

  }

}

```

When you next run `node_modules/.bin/markedly` it will now produce both `dist/posts/index.json`, along with `dist/posts/latestArticles.json`.

If you wanted a list of all articles sorted by day, you can skip the limit line.

``` json

{

  "markedly": {

    "lists": {

      "articlesArchive": {

        "sort": "publishedAt",

        "reverse": true

      }

    }

  }

}

```

This would produce a file called `dist/posts/articlesArchive.json`.

## License

MIT