Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/minkjs/mink
Live Markdown server and static-site generator.
https://github.com/minkjs/mink
handlebars includes markdown server static-site-generator
Last synced: about 1 month ago
JSON representation
Live Markdown server and static-site generator.
- Host: GitHub
- URL: https://github.com/minkjs/mink
- Owner: minkjs
- License: mit
- Created: 2017-07-13T18:12:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T10:14:10.000Z (2 months ago)
- Last Synced: 2024-10-01T15:04:11.593Z (about 1 month ago)
- Topics: handlebars, includes, markdown, server, static-site-generator
- Language: JavaScript
- Homepage:
- Size: 1.44 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 54
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Mink
> Remix your Markdown with this live Markdown server and static-site generator
[](https://travis-ci.com/minkjs/mink)
[](https://coveralls.io/github/minkjs/mink?branch=master)
[](https://www.npmjs.com/package/mink)
[](https://github.com/minkjs/mink/issues)
[](https://snyk.io/test/github/minkjs/mink)
[](https://github.com/sindresorhus/xo)
## About Mink
Use cases
- Web Server with live Markdown preview
- Static-site generator
- Software documentation tool
- Website generator
## How Mink Works
Mink launches an HTTP server from a local directory.
```shell
cd ~/repos/my-site
mink
```
- Mink renders your Markdown files as HTTP on the fly.
- Mink watches your files for changes, and re-renders them to all of your devices simultaneously.
- Mink exports your project to static files that can be uploaded to a server.
### Mixed-Mode Markdown
Mink uses Mixed-Mode Markdown, combining Handlebars templates with Markdown syntax.
```html
{{#each article}}
{{article.title}}
{{/each}}
```
### Include Syntax
Mink adds includes syntax to your HTML and Markdown files.
```
```
### Re-Usable Project Configuration
Mink lets your configure your projects with `Minkconf.js`.
```javascript
// File: Minkconf.js
const Minkconf = {
plugins: {
markdown: {
path: '**/*.md'
handler: 'mink-markdown'
}
},
watch: {
'**/*.md'
},
export: {
'**/*.md'
}
}
module.exports = Minkconf
```
### Custom Handlers
Mink lets you rapidly build custom handlers for http routes.
```javascript
// File: Minkconf.js
const typescript = require('typescript')
const Minkconf = {
plugins: {
typescript: {
path: '**/*.ts'
handler: $file => ts.transpileModule($file.contents).outputText
}
}
}
module.exports = Minkconf
```
## Why Mink Exists
1. Software Documentation
1. Blog and Static-Site Creation
1. Pull-Mode Task Runner
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.
## Getting Started
Installation:
```shell
yarn --global add mink
```
Launch server from the current directory:
```shell
mink
```
## Features
- Simple project configuration file (Markconf.js)
- Mink Server
+ Serves local directories as content
+ Markdown files are converted to HTML
+ Auto-reload on file changes
- Splice structrued content together, Eg:
+ HTML inside HTML with: ``
+ Markdown inside Markdown with: ``
+ Fetch external content: ``
+ Get the first 100 Fibonacci numbers from a plugin: ``
- Plugins
+ Write local project modules with simple plugin architecture
+ Publish your module to the NPM Registry
+ Add your module to your `package.json` file
+ Plugins can have their own Handlebars HTML templates
+ Plugins can return a `{body}` object to be rendered to a template
+ Pluings can also override and send the HTTP response themselves
- Export
+ Export the entire content as HTML to be uploaded
+ Export directory structure alongside binary files like images
+ Export to PDF
## Installation
Mink serves Markdown content from anywhere in your filesystem. You can install Mink globally.
```shell
yarn global add mink
```