Nougat Predominant Middleware
    Wondering what’s next for npm?Check out our public roadmap! »

    mdconf2
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.13 • Public • Published

    mdconf

    Markdown configuration parse => data / stringify => Markdown

    Using the fantastic markdown parser marked.

    Installation

    $ npm install mdconf2
    

    API

    Options

    export interface IOptionsParse
    {
    	crlf?: string,
    	oldParseApi?: boolean,
    
    	allowBlockquote?: boolean,
    
    	disableKeyToLowerCase?: boolean,
    }

    Demo

    let mdconf = require('mdconf2');
    let data = mdconf.parse('string of markdown');
    // => Object
    
    mdconf.stringify(data);
    // ==> string
    
    // will remove hidden data and get source data
    let data2 = mdconf.RawObject.removeRawData(data);
    // => Object

    Example

    Markdown headings act as keys, list items with : act as maps, otherwise regular lists behave as.. lists.

    # Defaults
    
      Since this is markdown you can still have regular text
      to explain what the hell is going on.
    
    ## Upload
    
      - max: 200mb
      - dir: /tmp
    
    ### Thumbnail sizes
    
      - 50x50
      - 300x300
      - 600x600
      - 900x900
    
    ## S3
    
      - api key: 111111
      - secret: 222222
    
    ### Buckets
    
      - avatars: myapp-avatars
      - assets: myapp-assets
      - files: myapp-files
    
    # Production
    
    ## Upload
    
      - max: 1gb
      - dir: /data/uploads
    
    ## Sites
    
    | hostname     | build   | coverage  |
    | :----------- | :------:| --------: |
    | google.com   | passing |       94% |
    | facebook.com | passing |       97% |
    | twitter.com  | failed  |       81% |
    | myspace.com  | unkown  |       0%  |

    output json:

    {
      "defaults": {
        "upload": {
          "max": "200mb",
          "dir": "/tmp",
          "thumbnail sizes": [
            "50x50",
            "300x300",
            "600x600",
            "900x900"
          ]
        },
        "s3": {
          "api key": "111111",
          "secret": "222222",
          "buckets": {
            "avatars": "myapp-avatars",
            "assets": "myapp-assets",
            "files": "myapp-files"
          }
        }
      },
      "production": {
        "upload": {
          "max": "1gb",
          "dir": "/data/uploads"
        },
        "sites": [
          {
            "hostname": "google.com",
            "build": "passing",
            "coverage": "94%"
          },
          {
            "hostname": "facebook.com",
            "build": "passing",
            "coverage": "97%"
          },
          {
            "hostname": "twitter.com",
            "build": "failed",
            "coverage": "81%"
          },
          {
            "hostname": "myspace.com",
            "build": "unkown",
            "coverage": "0%"
          }
        ]
      }
    }

    With markdown blocks you could easily use this as a tool for static site generation:

    # Scripts
    
      My site does almost nothing:
    
        document.write('<h1>mdconf</h1>')
        document.write('<p>Markdown configuration is pretty cool</p>')
    
    # Styles
    
      Main structural styling:
    
        body {
          padding: 50px;
          font: 14px Helvetica;
        }
    
      Some other stuff:
    
        button {
          padding: 15px;
        }

    yields:

    {
      "scripts": [
        "document.write('<h1>mdconf</h1>')\ndocument.write('<p>Markdown configuration is pretty cool</p>')"
      ],
      "styles": [
        "body {\n  padding: 50px;\n  font: 14px Helvetica;\n}",
        "button {\n  padding: 15px;\n}"
      ]
    }

    ports

    License

    (The MIT License)

    Copyright (c) 2013 TJ Holowaychuk <tj@vision-media.ca>

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    links

    Install

    npm i mdconf2

    DownloadsWeekly Downloads

    41

    Version

    2.0.13

    License

    ISC

    Unpacked Size

    64.8 kB

    Total Files

    22

    Last publish

    Collaborators

    • avatar