Git Product home page Git Product logo

frontmatter's Introduction

frontmatter

Build Status Dependency Status

A Clojure library designed to parse front matter from a file.

Supported front matter formats are follwoing:

  • YAML
  • JSON
  • EDN

Installation

Add following dependency to your profject.clj.

Clojars Project

Usage

(require '[frontmatter.core :as fm])

(fm/parse "foo.txt")
;=> {:frontmatter {:foo "bar"}
     :body "this is body"}

Front matter formats

YAML

  • YAML front matter is separated by ---.
---
hello: "world"
nums:
  - one
  - two
  - three
---

this is body

JSON

  • JSON front matter is separated by ;;;.
;;;
"hello": "world",
"nums": [
    "one",
    "two",
    "three"
]
;;;

this is body

EDN

  • EDN front matter is separated by ###.
###
:hello "world"
:nums [
    "one"
    "two"
    "three"
]
###

this is body

License

Copyright (C) 2014 Masashi Iizuka (@uochan)

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.