https://github.com/boehs/markdown-it-wikilinks
🔗🌱 A custom fork of markdown-it-wikilinks
https://github.com/boehs/markdown-it-wikilinks
markdown-it markdown-it-plugin
Last synced: 6 days ago
JSON representation
🔗🌱 A custom fork of markdown-it-wikilinks
- Host: GitHub
- URL: https://github.com/boehs/markdown-it-wikilinks
- Owner: boehs
- License: mit
- Created: 2022-02-27T23:00:56.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T12:14:29.000Z (about 3 years ago)
- Last Synced: 2025-04-12T10:15:12.116Z (11 months ago)
- Topics: markdown-it, markdown-it-plugin
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@gardeners/markdown-it-wikilinks
- Size: 276 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markdown-It Wikilinks
[](https://travis-ci.org/jsepia/markdown-it-wikilinks) [](https://coveralls.io/github/jsepia/markdown-it-wikilinks?branch=master)
Renders [Wikimedia-style links](https://www.mediawiki.org/wiki/Help:Links#Internal_links) in [markdown-it](https://github.com/markdown-it/markdown-it). This is useful for making Markdown-based wikis.
## Usage
Install this into your project:
```bash
npm --save install markdown-it-wikilinks
```
...and *use* it:
```js
const wikilinks = require('@gardeners/markdown-it-wikilinks')(options)
const md = require('markdown-it')()
.use(wikilinks)
.render('Click [[Wiki Links|here]] to learn about [[/Wiki]] links.')
```
**Output:**
```html
Click here to learn about Wiki links.
```
## Options
### `linkPattern`
**Default:** `/\[\[([^|]+?)(\|([\s\S]+?))?\]\]/`
The regex to use when matching WikiLinks.
```js
// Allow exclamation marks to be used.
const html = require('markdown-it')()
.use(require('@gardeners/markdown-it-wikilinks')({ linkPattern: /\[\[([\w\s/!]+)(\|([\w\s/!]+))?\]\]/ }))
.render('[[Slate!]]')
//
```
### `imagePattern`
**Default:** undefined
The common regex for images is `/!\[\[([^]+?)\]\]/` (note the inclusion of ! at the start).
### `assetPrefix`
**Default:** ''
A prefix for image urls, normally `/assets/`
### `baseURL`
**Default:** `/`
The base URL for absolute wiki links.
```js
const html = require('markdown-it')()
.use(require('@gardeners/markdown-it-wikilinks')({ baseURL: '/wiki/' }))
.render('[[/Main Page]]')
//
```
### `relativeBaseURL`
**Default:** `./`
The base URL for relative wiki links.
```js
const html = require('markdown-it')()
.use(require('@gardeners/markdown-it-wikilinks')({ relativeBaseURL: '#', suffix: '' }))
.render('[[Main Page]]')
//
```
### `makeAllLinksAbsolute`
**Default:** `false`
Render all wiki links as absolute links.
### `uriSuffix`
**Default:** `.html`
Append this suffix to every URL.
```js
const html = require('markdown-it')()
.use(require('@gardeners/markdown-it-wikilinks')({ uriSuffix: '.php' }))
.render('[[Main Page]]')
//
```
### `htmlAttributes`
**Default:** `{}`
An object containing HTML attributes to be applied to every link.
```js
const attrs = {
'class': 'wikilink',
'rel': 'nofollow'
}
const html = require('markdown-it')()
.use(require('@gardeners/markdown-it-wikilinks')({ htmlAttributes: attrs }))
.render('[[Main Page]]')
//
```
### `generatePageNameFromLabel`
Unless otherwise specified, the labels of the links are used as the targets. This means that a non-[piped](https://meta.wikimedia.org/wiki/Help:Piped_link) link such as `[[Slate]]` will point to the `Slate` page on your website.
But say you wanted a little more flexibility - like being able to have `[[Slate]]`, `[[slate]]`, `[[SLATE]]` and `[[Slate!]]` to all point to the same page. Well, you can do this by providing your own custom `generatePageNameFromLabel` function.
#### Example
```js
const _ = require('lodash')
function myCustomPageNameGenerator(label) {
return label.split('/').map(function(pathSegment) {
// clean up unwanted characters, normalize case and capitalize the first letter
pathSegment = _.deburr(pathSegment)
pathSegment = pathSegment.replace(/[^\w\s]/g, '')
// normalize case
pathSegment = _.capitalize(pathSegment.toLowerCase())
return pathSegment
})
}
const html = require('markdown-it')()
.use(require('@gardeners/mardkwon-it-wikilinks')({ generatePageNameFromLabel: myCustomPageNameGenerator }))
.render('Vive la [[révolution!]] VIVE LA [[RÉVOLUTION!!!]]')
//
Vive la révolution! VIVE LA RÉVOLUTION!!!
```
Please note that the `generatePageNameFromLabel` function does not get applied for [piped links](https://meta.wikimedia.org/wiki/Help:Piped_link) such as `[[/Misc/Cats/Slate|kitty]]` since those already come with a target.
### `postProcessPageName`
A transform applied to every page name. You can override it just like `generatePageNameFromLabel` (see above).
The default transform does the following things:
- trim surrounding whitespace
- [sanitize](https://github.com/parshap/node-sanitize-filename) the string
- replace spaces with underscores
### `postProcessLabel`
A transform applied to every link label. You can override it just like `generatePageNameFromLabel` (see above).
All the default transform does is trim surrounding whitespace.
### `includeWikilinks`
**Default:** `false`
Include wikilink delimiters (`[[`, `]]`) in output
- **false**: Do not include delimiters in output
- **"inner"**: Include delimiters inside the link
- **"outer"**: Wrap the link with delimiters
## TODO
- Unit test options
- Add examples to `postProcessPageName` and `postProcessLabel`
## Credits
Based on [markdown-it-ins](https://github.com/markdown-it/markdown-it-ins) by Vitaly Puzrin, Alex Kocharin.
### Differences with [`markdown-it-obsidian`](https://www.npmjs.com/package/markdown-it-obsidian)
- Wikistyle images via that fork
- `markdown-it-obsidian` checks that the page exists before linking, `@gardeners/markdown-it-wikilinks` does not