GithubHelp home page GithubHelp logo

593413198 / hexo-markmap Goto Github PK

View Code? Open in Web Editor NEW

This project forked from maxchang3/hexo-markmap

0.0 0.0 0.0 3.19 MB

A hexo plugin insert mindmap in your hexo blog by markmap.

Home Page: https://www.npmjs.com/package/hexo-markmap

License: MIT License

Shell 2.40% JavaScript 97.60%

hexo-markmap's Introduction

| English | 简体中文 | 繁体中文 |

Depend on markmap. Inspired by hexo-simple-mindmap.

hexo-markmap

Insert mindmap in your hexo blog by markmap.

From now all the syntax like HTML codes, links, inline code, markdown KaTeX, and Codeblocks are possible to use.

Codeblocks still have some problems which may throw some errors. More preview in my blog.

Install

pnpm add hexo-markmap -D
npm install hexo-markmap  --save
yarn add hexo-markmap --dev

Usage

{% markmap height [depth] %}
- Markdown
- Syntax
{% endmarkmap %}

Options

  • height: mindmap canvas height
  • depth: optional, when specified, automatically fold nodes with level greater than depth

Example

{% markmap 400px %}
- links
- **inline** ~~text~~ *styles*
- multiline
  text
- `inline code`
- ```js
  console.log('code block');
  console.log('code block');
  ```
- KaTeX - $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$
{% endmarkmap %}

Config

Add your options to config.yml.

Convention over configuration, if you don’t need any of the following features, then you don’t need to add these configs.

By default, it works well. Each option has a default value.

pjax fixing

default value false

hexo_markmap:
  pjax: true

If your blog has pjax installed, please turn it on.

KaTeX

default value false

hexo_markmap:
  katex: true

If you need to use $K\kern-.25em\raise.45ex {\scriptstyle{A}}\kern-.15em\TeX$, please turn it on to insert the CSS links. If your $K\kern-.25em\raise.45ex {\scriptstyle{A}}\kern-.15em\TeX$ was already added in your blog by another way, then you needn't to do it.

If your blog has MathJax installed, please turn it on.

Prism

default value false

hexo_markmap:
  prism: true

If you need to use code blocks, please turn it on to insert the CSS links. If prism.css has already been added to your blog by another way, then you don’t need to do it.

Custom CDN

hexo_markmap:
  userCDN:
    d3_js: https://fastly.jsdelivr.net/npm/d3@6
    markmap_view_js: https://fastly.jsdelivr.net/npm/[email protected]
    katex_css: https://fastly.jsdelivr.net/npm/[email protected]/dist/katex.min.css
    prism_css: https://fastly.jsdelivr.net/npm/[email protected]/themes/prism.css

Lock view

default value false

Disable the zoom and pan of the view.

hexo_markmap:
  lock: true

default option

hexo_markmap:
  pjax: false
  katex: false
  prism: false
  userCDN:
    d3_js: https://fastly.jsdelivr.net/npm/d3@6
    markmap_view_js: https://fastly.jsdelivr.net/npm/[email protected]
    katex_css: https://fastly.jsdelivr.net/npm/[email protected]/dist/katex.min.css
    prism_css: https://fastly.jsdelivr.net/npm/[email protected]/themes/prism.css
  lockView: false

hexo-markmap's People

Contributors

593413198 avatar appotry avatar coderxi1 avatar galensgan avatar maxchang3 avatar phamour avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.