Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tj/mdconf
Markdown driven configuration!
https://github.com/tj/mdconf
Last synced: 30 days ago
JSON representation
Markdown driven configuration!
- Host: GitHub
- URL: https://github.com/tj/mdconf
- Owner: tj
- Created: 2013-06-05T03:51:55.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-11-24T00:19:15.000Z (about 7 years ago)
- Last Synced: 2024-11-07T15:16:36.595Z (about 1 month ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 509
- Watchers: 9
- Forks: 29
- Open Issues: 4
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
Awesome Lists containing this project
README
# mdconf
Markdown driven configuration!
Using the fantastic markdown parser [marked](https://github.com/chjj/marked).
## Installation
```
$ npm install mdconf
```
## ports
- [Python port](https://github.com/hit9/mdconf.py)
## API
```js
var parse = require('mdconf');
parse('string of markdown');
// => Object
```
## Example
Markdown headings act as keys, list items with `:` act as maps,
otherwise regular lists behave as.. lists.
```markdown
# 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:
```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:
```md
# Scripts
My site does almost nothing:
document.write('
mdconf
')
document.write('Markdown configuration is pretty cool
')
# Styles
Main structural styling:
body {
padding: 50px;
font: 14px Helvetica;
}
Some other stuff:
button {
padding: 15px;
}
```
yields:
```js
{
"scripts": [
"document.write('
mdconf
')\ndocument.write('Markdown configuration is pretty cool
')"
],
"styles": [
"body {\n padding: 50px;\n font: 14px Helvetica;\n}",
"button {\n padding: 15px;\n}"
]
}
```
## License
(The MIT License)
Copyright (c) 2013 TJ Holowaychuk <[email protected]>
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.