Live Markdown server and static-site generator.
MIT License
Remix your Markdown with this live Markdown server and static-site generator
Use cases
Mink launches an HTTP server from a local directory.
cd ~/repos/my-site
mink
Mink uses Mixed-Mode Markdown, combining Handlebars templates with Markdown syntax.
{{#each article}}
<article>
<h2>{{article.title}}</h2>
</article>
{{/each}}
Mink adds includes syntax to your HTML and Markdown files.
<!-- File: index.html -->
<head>
<!-- mink: styles.less -->
</head>
<body>
<!-- mink: home-page.md -->
</body>
Mink lets your configure your projects with Minkconf.js
.
// File: Minkconf.js
const Minkconf = {
plugins: {
markdown: {
path: '**/*.md'
handler: 'mink-markdown'
}
},
watch: {
'**/*.md'
},
export: {
'**/*.md'
}
}
module.exports = Minkconf
Mink lets you rapidly build custom handlers for http routes.
// File: Minkconf.js
const typescript = require('typescript')
const Minkconf = {
plugins: {
typescript: {
path: '**/*.ts'
handler: $file => ts.transpileModule($file.contents).outputText
}
}
}
module.exports = Minkconf
Mink is a powerful command-line tool used to produce written content for the web. Mink is designed from the ground up for technical writting, blogging and software documentation. Mink lets you slice, dice and remix structured Markdown content in realtime. Mink serves your content while you create, then exports your flattened project as part of your build pipeline.
Installation:
yarn --global add mink
Launch server from the current directory:
mink
<!-- mink | path/to/foo.html -->
<!-- mink | path/to/bar.md -->
<!-- mink | https://en.wikipedia.org/wiki/Cat -->
<!-- mink | fibonacci | {n: 100} -->
package.json
file{body}
object to be rendered to a templateMink serves Markdown content from anywhere in your filesystem. You can install Mink globally.
yarn global add mink