gatsby-remark-markmap

v0.3.5

Visualize code blocks in Markdown files using [markmap-lib](https://github.com/gera2ld/markmap-lib).

NPM

README

GitHub

Website

MIT

Latest version published 1 month ago

    npm install gatsby-remark-markmap

We couldn't find any similar packages Browse all packages

Package Health Score

59 / 100

Popularity
Limited
Maintenance
Sustainable
Security
No known security issues
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (2)

Dependents: 0
GitHub Stars: 24
Forks: 2
Contributors: 1

The npm package gatsby-remark-markmap receives a total of 2 downloads a week. As such, we scored gatsby-remark-markmap popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package gatsby-remark-markmap, we found that it has been starred 24 times, and that 0 other projects on the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.1.1

0.2.1

0.3.5

Indirect Vulnerabilities

0.1.1

0.2.1

0.3.5

License Risks

0.1.1

0.2.1

0.3.5

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security Policy: No

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like gatsby-remark-markmap is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test gatsby-remark-markmap

Fix it in your project with Snyk!

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Merged PR: 0
Open PR: 0
Last Commit: 1 month ago

Further analysis of the maintenance status of gatsby-remark-markmap based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that gatsby-remark-markmap demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No
License: MIT

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like gatsby-remark-markmap is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 1 year
Dependencies: 3 Direct / 23 Total
Versions: 11
Install Size: 6.19 kB
Dist-tags: 1
# of Files: 6
Maintainers: 1
TS Typings: No

We detected a total of 23 direct & transitive dependencies for gatsby-remark-markmap. See the full dependency tree of gatsby-remark-markmap

gatsby-remark-markmap has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

gatsby-remark-markmap

Visualize code blocks in Markdown files using markmap-lib.

Demo

Input:

Render Markdown as mindmap:

```markmap
# Food
## Fruits
- easy to eat
  - apple
  - banana
- not so easy
  - grapes
## Vegetables
- cabbage
- tomato
```

Output:

Installation

$ yarn add gatsby-remark-markmap

Usage

In your gatsby-config.js:

plugins: [
  {
    resolve: 'gatsby-transformer-remark',
    options: {
      plugins: [
        // Note that `gatsby-remark-markmap` must be put before other plugins
        // that handle code blocks, e.g. `gatsby-remark-prismjs`
        'gatsby-remark-markmap',
        'gatsby-remark-prismjs',
      ],
    },
  },
]

Options

options.loadDeps

A function to load dependencies before creating markmaps. By default it loads d3@5 from jsdelivr.com.
options.markmap, default as {}

Passed to markmap-lib.
options.plugins, default as []

An array of extension features to be enabled for markmap. Current available plugins are:
- mathJax: transform MathJax syntax
- prism: highlight code blocks with PrismJS

Here is an example using options:

{
  resolve: 'gatsby-remark-markmap',
  options: {
    markmap: {/* markmap options */},
    plugins: ['mathJax', 'prism'],
  },
},

Code

Code blocks with a language of markmap will be transformed into interactive markmaps. You can also prepend a comment to leverage Markdown syntax highlight:

```markdown
<!-- render-as-markmap -->

# markmap
## contents
```

coc-markmap - Vim / NeoVim plugin powered by coc.nvim
markmap-lib - Standalone command line version