https://github.com/sukkaw/recipage

:page_with_curl: Reci(pe)page: Turn a markdown file into one simple page
https://github.com/sukkaw/recipage

browser javascript js markdown md renderer

Last synced: 27 days ago
JSON representation

:page_with_curl: Reci(pe)page: Turn a markdown file into one simple page

• Host: GitHub
• URL: https://github.com/sukkaw/recipage
• Owner: SukkaW
• License: mit
• Created: 2018-11-07T00:55:50.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-07-13T12:48:07.000Z (over 5 years ago)
• Last Synced: 2024-10-06T11:19:40.432Z (about 1 month ago)
• Topics: browser, javascript, js, markdown, md, renderer
• Language: JavaScript
• Homepage: https://suka.js.org/recipage/
• Size: 155 KB
• Stars: 13
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        






recipage


> :page_with_curl: reci(pe)page: Turn a markdown file into one simple page

[![npm](https://img.shields.io/npm/v/recipage.svg?style=flat-square)](https://www.npmjs.com/package/recipage) [![Author](https://img.shields.io/badge/Author-Sukka-b68469.svg?style=flat-square)](https://skk.moe) [![npm](https://img.shields.io/npm/l/recipage.svg?style=flat-square)](https://github.com/SukkaW/recipage/blob/master/LICENSE) [![size](https://img.badgesize.io/SukkaW/recipage/master/dist/recipage.js?style=flat-square&compression=gzip)](https://github.com/SukkaW/recipage/tree/master/dist) [![Travis](https://img.shields.io/travis/SukkaW/recipage.svg?style=flat-square)](https://travis-ci.org/SukkaW/recipage) [![devDependency Status](https://img.shields.io/david/dev/SukkaW/recipage.svg?style=flat-square)](https://david-dm.org/SukkaW/recipage#info=devDependencies) [![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/recipage/badge)](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

    

    

    

    


    window.$recipage = {

        // Config here...

    }

```

## 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/[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')

    }

}

```

## Author

**recipage** © [Sukka](https://github.com/SukkaW), Released under the [MIT](https://github.com/SukkaW/recipage/blob/master/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)