markdown-ime

v1.0.3

MarkdownIME is a fresh and fast way to make text formatted, and a minimal & powerful web rich-text editor. For more information about how to use this package see README

Latest version published 6 years ago

License: Apache-2.0

NPM

GitHub

Package Health Score

45 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Security

No known security issues

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

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.0.3	\|	09/2018	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (3)

GitHub Stars: 469
Forks: 54
Contributors: 1

Direct Usage Popularity

The npm package markdown-ime receives a total of 3 downloads a week. As such, we scored markdown-ime popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package markdown-ime, we found that it has been starred 469 times.

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

Community

Limited

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

This project has seen only 10 or less contributors.

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

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 5
Open PR: 0
Last Release: 6 years ago
Last Commit: 6 years ago

Further analysis of the maintenance status of markdown-ime based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for markdown-ime is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 0 Direct
Versions: 5
Install Size: 220 kB
Dist-tags: 1
# of Files: 53
Maintainers: 1
TS Typings: Yes

markdown-ime 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.

Readme

MarkdownIME

MarkdownIME is a fresh and fast way to make text formatted, and a minimal & powerful web rich-text editor.

MINIMAL: No 3rd-party dependency. No buttons or stylesheets. Only require one div[contentEditable] and one script tags.
POWERFUL: With Markdown markups and shortkeys, you can typeset your document on-the-fly.

Try out the demo. Works like a charm on desktop and mobile!

npm bundle size (minified) npm bundle size (minified + gzip)

Quickstart / Guide

Make a simpliest editor:

Include MarkdownIME
- Via NPM: const MarkdownIME = require("markdown-ime")
- or, via Script Tag: ``
Insert an HTML tag: <div id="editor"><p>Hello World</p></div>
Activate MarkdownIME in one JavaScript: MarkdownIME.Enhance(MarkdownIME.Scan(window));

Using other editor like TinyMCE / Quill? Please follow the examples.

More info can be found in examples and manual

Features

Notice

With MarkdownIME, user inputs Markdown, you get HTML Nodes instantly -- all Markdown markups are discarded.

If you want the intact Markdown rather than rendered HTML, maybe HyperMD -- a WYSIWYG Markdown Editor is what you need!

Supported Editor

Vanilla contenteditable elements - a div[contentEditable] makes everything.
Other rich-text editor based on contentEditable
- TinyMCE, Quill, WangEditor and more, see examples

Supported Shorkeys

Full list can be found here.

Key	Feature	Key	Feature
`Ctrl + I`	Toggle Italic	`Ctrl + B`	Toggle Bold
`Ctrl + U`	Toggle Underline
`Ctrl + Shift + =`	superscript	`Ctrl + =`	subscript
`Ctrl + L`	justifyLeft	`Ctrl + E`	justifyCenter
`Ctrl + R`	justifyRight

Key	Feature
`	Mark selected text as inline-code

Shortkeys in Tables

Key	Feature	Key	Feature
`Insert`	Insert a column after	`Shift + Insert`	Insert a column before
`Tab`	Go next cell, or insert a row	`Shift + Tab`	Go previous cell
`Up`	Go cell above current	`Down`	Go cell under current

Key	Feature
`Enter`	If current row is empty, finish the table. Otherwise, insert a row below.

Note that some shortkeys might be unavaliable in some browsers; MarkdownIME shortkeys are disabled in TinyMCE by default.

Supported Markdown Markups

Block Elements

Headers (beginning with # )
Horizontal ( --- )
(Nested) Lists
(Nested) Blockquote
Code Block

Span Elements

Links
Emphasis
In-line Code
~~Strikethrough~~
Images
Emojis ( eg. :) or :smile: )

Tables

Create a table with | table | column | headers | and Enter key
Use shortkeys to navigate and master the table (see above)

FAQs

What is markdown-ime?

MarkdownIME is a fresh and fast way to make text formatted, and a minimal & powerful web rich-text editor. Visit Snyk Advisor to see a full health score report for markdown-ime, including popularity, security, maintenance & community analysis.

Is markdown-ime popular?

The npm package markdown-ime receives a total of 3 weekly downloads. As such, markdown-ime popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is markdown-ime well maintained?

We found indications that markdown-ime is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is markdown-ime safe to use?

The npm package markdown-ime was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 19 December-2024, at 09:27 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP