Socket
Socket
Sign inDemoInstall

markdown-typora

Package Overview
Dependencies
0
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    markdown-typora

A renderer that can render md documents into html and customize styles can be well compatible with typora's css styles.


Version published
Weekly downloads
28
increased by47.37%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

介绍

这是一个markdown文件解析加渲染一体的功能,可以很好的适应Typora的主题模板

下载

npm i markdown-typora

使用

以vue3为例:

//模块引入
import {markdownToHTML, hljs} from 'markdown-typora'
import md from '@/article/1.md?raw'
import {onMounted} from 'vue'

onMounted(() => {
  const write = document.querySelector('#write')
  write.innerHTML = markdownToHTML(md)
// 代码高亮调用函数
  hljs.highlightAll()
})

此时md文件被转为了html,但是没有css样式,可以自己找css样式,推荐的网站:Themes Gallery — Typora,也可以使用我为你准备的,放在源代码的dist/styles中,直接复制里面的内容,自己新建一个css文件即可,比如:src/assets/css/md_theme.css,然后再main.js中引入即可:

import '@/assets/css/md_theme.css'

引入库

  1. markdown-it
  2. highlight.js

ts版本

可以查看https://www.npmjs.com/package/markdown-typora-ts

Keywords

FAQs

Last updated on 12 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc