Skip to content

Keep README up-to-date #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Keep README up-to-date #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,15 @@ npm i -D markdown-it-vuepress-code-snippet-enhanced

## Setup

In Vuepress `config.js` add the following:
In Vuepress `config.js` add the following:

```js
markdown: {
config: md => {
module.exports = {
markdown: {
extendMarkdown: md => {
md.use(require('markdown-it-vuepress-code-snippet-enhanced'))
}
}
}
```

Expand Down Expand Up @@ -65,8 +67,8 @@ For transcluding one or **more** parts of a file, specify a unique pattern.
```
##### Example 1
```rb
require 'lib'
require 'other'
require 'lib'
require 'other'

# |_|_|
def hello
Expand All @@ -78,8 +80,8 @@ end

##### Example 2 (Illustrating multiple transclusions in the same file)
```rb
require 'lib'
require 'other'
require 'lib'
require 'other'

# |_|_|
def hello
Expand Down Expand Up @@ -119,7 +121,7 @@ Use a range indicating the `start` and `end` lines. This option is inclusive.
@[code highlight={1-6} transcludeTag=style](@/docs/code.vue)
```

### Source File
### Source File
```html
<template>
<div class="component"></div>
Expand Down