馃搩 reci(pe)page: Turn a markdown file into one simple page
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.
Manually create index.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Recipage</title>
<meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1">
<meta name="theme-color" content="#f5f5f5">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/recipage/dist/recipage.min.css">
</head>
<body>
<div id="app"></div>
</body>
<script>
window.$recipage = {
// Config here...
}
</script>
<script src="https://cdn.jsdelivr.net/npm/recipage"></script>
</html>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/[email protected]' // 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')
}
}recipage 漏 Sukka, Released under the MIT License.
Authored and maintained by Sukka with help from contributors (list).
Personal Website 路 Blog 路 GitHub @SukkaW 路 Telegram Channel @SukkaChannel 路 Twitter @isukkaw 路 Keybase @sukka
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent