recipage
> :page_with_curl: reci(pe)page: Turn a markdown file into one simple page
[](https://www.npmjs.com/package/recipage)
[](https://skk.moe)
[](./LICENSE)
[](https://github.com/SukkaW/recipage/tree/master/dist)
[](https://travis-ci.org/SukkaW/recipage)
[](https://david-dm.org/SukkaW/recipage#info=devDependencies)
[](https://www.jsdelivr.com/package/npm/recipage)
## Intro
**recipage** generates your one page website using markdown on the fly. Unlike GitBook or Jekyll, it does not generate static html files. Unlike docsify or docute, it only support one page. To start using it, all you need to do is create an `index.html` and deploy to anywhere you want.
## Demo
- https://suka.js.org/recipage/
## Usage
Manually create `index.html`
```html
Recipage
```
## Configurations
```javascript
window.$recipage = {
url: './README.md', // The URL of markdown file
github: 'https://github.com/SukkaW/recipage', // The github-corner link (not necessary)
footer: { // The footer config (not necessary)
title: 'Recipage', // The title of the page that will be show at the footer
logo: 'https://cdn.jsdelivr.net/npm/skx@0.0.1' // A small image that will be show at the footer
},
callback: function() { // The callback function after rendering. For highlight or MathJax (not necessary)
console.log('Hey')
}
}
```
## Author
**recipage** © [Sukka](https://github.com/SukkaW), Released under the [MIT](./LICENSE) License.
Authored and maintained by Sukka with help from contributors ([list](https://github.com/SukkaW/recipage/graphs/contributors)).
> [Personal Website](https://skk.moe) · [Blog](https://blog.skk.moe) · GitHub [@SukkaW](https://github.com/SukkaW) · Telegram Channel [@SukkaChannel](https://t.me/SukkaChannel) · Twitter [@isukkaw](https://twitter.com/isukkaw) · Keybase [@sukka](https://keybase.io/sukka)