Noiseless Party Machine

    kamokamo

    0.0.18 • Public • Published

    鴨鴨 Kamokamo

    Convert Markdown files to Json data.

    Install

    npm i kamokamo

    Usage

    Output to stdout

    kamokamo

    Write a Json file

    kamokamo > the-output-folder/the-json-file.json

    Folders

    Default

    Place the markdown files (with .md extension) in a folder named content.

    Custom

    If the project needs another folder name or has mutiple folders containing markdown files, create a config file named kamokamo.config.json.

    It should contain the array dirs.

    Example

    We need to handle four folders: pages, posts, events and projects.

    Here is the content of our kamokamo.config.json config file:

    {
      "dirs": ["pages", "posts", "events", "projects"]
    }
    

    Home

    The object key of a content can be rewritten as "/" for a future usage as a homepage path.

    Example

    We want the contents of /pages/home.md to be used for our homepage.

    Here is the config:

    {
      "home": "/pages/home"
    }
    

    Dates

    Frontmatter fields named date or dates are processed.

    They can be of type String or Array of Strings.

    Formatting uses date-fns format

    Geocoding

    Kamokamo can geocode an address string to geo datas thanks to the Nominatim API.

    Each front matter address field should be added to the config file like:

    {
      "geoFields": ["address"]
    }
    

    Then, the object key geo is added to the json content.

    It is an array containing each address field and, for each, geo datas retrieved from the Nominatim API like lat and lon.

    Undocumented params

    Have a look at lib/set-config.js for yet undocumented params :)

    Keywords

    Install

    npm i kamokamo

    DownloadsWeekly Downloads

    0

    Version

    0.0.18

    License

    GPL-3.0

    Unpacked Size

    50.1 kB

    Total Files

    20

    Last publish

    Collaborators

    • alexronsaut