Skip to content
This repository has been archived by the owner on Dec 8, 2022. It is now read-only.

Commit

Permalink
Merge pull request #22 from JanGuillermo/1.0.3
Browse files Browse the repository at this point in the history
🚢 Ship 1.0.3
  • Loading branch information
JanGuillermo committed Sep 17, 2020
2 parents d3984f5 + 8915cc4 commit c624796
Show file tree
Hide file tree
Showing 7 changed files with 105 additions and 97 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.3] - 2020-09-16
### Added
- Added `linkify` property

### Changed
- Reduced production library size

### Removed
- `markdown-it-strikethrough-alt` dependency

## [1.0.2] - 2020-09-15
### Added
- Added information on README for including LaTeX + highlight.js styles
Expand Down Expand Up @@ -40,5 +50,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists) - Add task lists
- [markdown-it-toc-done-right](https://github.com/nagaozen/markdown-it-toc-done-right) - Add table of contents

[1.0.3]: https://github.com/JanGuillermo/vue3-markdown-it/compare/v1.0.2...v1.0.3
[1.0.2]: https://github.com/JanGuillermo/vue3-markdown-it/compare/v1.0.1...v1.0.2
[1.0.1]: https://github.com/JanGuillermo/vue3-markdown-it/releases/tag/v1.0.1
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@
<img width="200" src="logo.png" alt="logo">
</p>

# vue3-markdown-it
# vue3-markdown-it

[![GitHub package.json version](https://img.shields.io/github/package-json/v/JanGuillermo/vue3-markdown-it)](https://www.npmjs.com/package/vue3-markdown-it) [![Build Status](https://travis-ci.com/JanGuillermo/vue3-markdown-it.svg?branch=master)](https://travis-ci.com/JanGuillermo/vue3-markdown-it) [![codecov](https://codecov.io/gh/JanGuillermo/vue3-markdown-it/branch/master/graph/badge.svg)](https://codecov.io/gh/JanGuillermo/vue3-markdown-it) [![Dependencies Status](https://david-dm.org/JanGuillermo/vue3-markdown-it.svg)](https://david-dm.org/JanGuillermo/vue3-markdown-it) [![Known Vulnerabilities](https://snyk.io/test/github/JanGuillermo/vue3-markdown-it/badge.svg?targetFile=package.json)](https://snyk.io/test/github/JanGuillermo/vue3-markdown-it?targetFile=package.json) [![npm](https://img.shields.io/npm/dt/vue3-markdown-it)](https://www.npmjs.com/package/vue3-markdown-it)

> A Vue 3 [markdown-it](https://github.com/markdown-it/markdown-it) wrapper plugin.
🔎 [Live Demo](https://janguillermo.github.io/vue3-markdown-it/)

---

## Installation
```
npm install vue3-markdown-it
Expand All @@ -24,7 +28,6 @@ npm install vue3-markdown-it
- [markdown-it-ins](https://github.com/markdown-it/markdown-it-ins) - Add `<ins>` tags
- [markdown-it-latex](https://github.com/tylingsoft/markdown-it-latex) - Add LaTeX formatting
- [markdown-it-mark](https://github.com/markdown-it/markdown-it-mark) - Add marking/highlighting
- [markdown-it-strikethrough-alt](https://github.com/jay-hodgson/markdown-it-strikethrough-alt) - Add strikethrough
- [markdown-it-sub](https://github.com/markdown-it/markdown-it-sub) - Add subscript
- [markdown-it-sup](https://github.com/markdown-it/markdown-it-sup) - Add superscript
- [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists) - Add task lists
Expand Down Expand Up @@ -109,6 +112,11 @@ Type: `Boolean` | Default value: `false`
Type: `String` | Default value: `language-`

### `linkify`
> Autoconvert URL-like text to links
Type: `Boolean` | Default value: `false`

### `quotes`
> Double + single quotes replacement pairs, when typographer enabled and smartquotes on. Could be either a String or an Array. *For example*, you can use `«»„“` for Russian, `„“‚‘` for German, and `['«\xA0', '\xA0»', '‹\xA0', '\xA0›']` for French (including nbsp).
Expand Down
14 changes: 0 additions & 14 deletions __tests__/plugins/markdown-it-strikethrough-alt.spec.js

This file was deleted.

2 changes: 0 additions & 2 deletions __tests__/render.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import MarkdownItHighlightjs from 'markdown-it-highlightjs';
import MarkdownItIns from 'markdown-it-ins';
import MarkdownItLatex from 'markdown-it-latex';
import MarkdownItMark from 'markdown-it-mark';
import MarkdownItStrikethroughAlt from 'markdown-it-strikethrough-alt';
import MarkdownItSub from 'markdown-it-sub';
import MarkdownItSup from 'markdown-it-sup';
import MarkdownItTasklists from 'markdown-it-task-lists';
Expand All @@ -26,7 +25,6 @@ md.use(MarkdownItAbbr)
.use(MarkdownItIns)
.use(MarkdownItLatex)
.use(MarkdownItMark)
.use(MarkdownItStrikethroughAlt)
.use(MarkdownItSub)
.use(MarkdownItSup)
.use(MarkdownItTasklists)
Expand Down
147 changes: 75 additions & 72 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 4 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vue3-markdown-it",
"version": "1.0.2",
"version": "1.0.3",
"author": "Jan Guillermo",
"description": "A Vue markdown-it wrapper plugin",
"license": "MIT",
Expand All @@ -11,10 +11,9 @@
"markdown",
"markdown-it"
],
"main": "dist/vue3-markdown-it.common.js",
"module": "dist/vue3-markdown-it.umd.js",
"main": "dist/vue3-markdown-it.umd.min.js",
"scripts": {
"build": "vue-cli-service build --target lib ./src/index.js",
"build": "vue-cli-service build --formats umd-min --target lib ./src/index.js",
"lint": "vue-cli-service lint",
"test": "vue-cli-service test:unit",
"prepare": "npm run test && npm run build"
Expand All @@ -30,7 +29,6 @@
"markdown-it-ins": "^3.0.0",
"markdown-it-latex": "^0.2.0",
"markdown-it-mark": "^3.0.0",
"markdown-it-strikethrough-alt": "^1.0.0",
"markdown-it-sub": "^1.0.0",
"markdown-it-sup": "^1.0.0",
"markdown-it-task-lists": "^2.1.1",
Expand All @@ -54,6 +52,7 @@
"vue": "^3.0.0-rc.11",
"vue-jest": "^5.0.0-0"
},
"homepage": "https://janguillermo.github.io/vue3-markdown-it/",
"repository": {
"type": "git",
"url": "https://github.com/JanGuillermo/vue3-markdown-it.git"
Expand Down
7 changes: 5 additions & 2 deletions src/vue-markdown-it.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import MarkdownItHighlightjs from 'markdown-it-highlightjs';
import MarkdownItIns from 'markdown-it-ins';
import MarkdownItLatex from 'markdown-it-latex';
import MarkdownItMark from 'markdown-it-mark';
import MarkdownItStrikethroughAlt from 'markdown-it-strikethrough-alt';
import MarkdownItSub from 'markdown-it-sub';
import MarkdownItSup from 'markdown-it-sup';
import MarkdownItTasklists from 'markdown-it-task-lists';
Expand Down Expand Up @@ -41,6 +40,10 @@ const props = {
type: String,
default: 'language-'
},
linkify: {
type: Boolean,
default: false
},
quotes: {
type: String,
default: '“”‘’'
Expand Down Expand Up @@ -83,7 +86,6 @@ export default {
.use(MarkdownItIns)
.use(MarkdownItLatex)
.use(MarkdownItMark)
.use(MarkdownItStrikethroughAlt)
.use(MarkdownItSub)
.use(MarkdownItSup)
.use(MarkdownItTasklists, props.tasklists)
Expand All @@ -92,6 +94,7 @@ export default {
breaks: props.breaks,
html: props.html,
langPrefix: props.langPrefix,
linkify: props.linkify,
quotes: props.quotes,
typographer: props.typographer,
xhtmlOut: props.xhtmlOut
Expand Down

0 comments on commit c624796

Please sign in to comment.