masahiro111 / zenn-editor Goto Github PK

CLI Documentation

• Connect GitHub repository to Zenn
• Install Zenn CLI
• Zenn CLI Guide

Use on your website

1. Convert markdown to html with zenn-markdown-html.

import markdownHtml from "zenn-markdown-html"

const html = markdownHtml(markdown);

2. Import styles for content.

import "zenn-content-css"

3. Enable web-components for embedding.

Some embedded contents such as Tweet, Gist are made with Web Components. To enable these contents embedded, import zenn-embed-elements on client.

// with React
useEffect(()=> {
  import('zenn-embed-elements');
})

Note that zenn-embed-elements is not working with SSR.

Authors

• CatNose (@catnose99)
• Hori Godai (@steelydylan)

Contributors

• noriaki watanabe (@nnabeyang)
• ooooooo_q (@ooooooo-q)
• RyotaK (@Ry0taK)
• j5c8k6m8 (@j5c8k6m8)
• kkiyama117 (@kkiyama117)

Licence

MIT