Giter VIP home page Giter VIP logo

markdown-it-wikicustom's Introduction

Markdown-It Wiki Custom Links

Renders Wiki-like links in markdown-it. This is useful for making Markdown-based wikis.

Usage

Install this into your project:

npm --save install markdown-it-wikicustom

...and use it:

const wikilinks = require('markdown-it-wikicustom')(options)
const md = require('markdown-it')()
    .use(wikilinks)
    .render('Click [[Wiki Links|here]] to learn about [[/Wiki]] links.')

Output:

<p>Click <a href="Wiki-Links">here</a> to learn about <a href="Wiki">Wiki</a> links.</p>

Options

baseURL

Default: ``

The base URL for absolute wiki links.

const html = require('markdown-it')()
  .use(require('markdown-it-wikicustom')({ baseURL: '/wiki/' }))
  .render('[[Main Page]]')
  // <p><a href="/wiki/Main-Page.html">Main Page</a></p>

relativeBaseURL

Default: ``

The base URL for relative wiki links.

const html = require('markdown-it')()
  .use(require('markdown-it-wikicustom')({ relativeBaseURL: '#', suffix: '' }))
  .render('[[Main Page]]')
  // <p><a href="#Main-Page">Main Page</a></p>

makeAllLinksAbsolute

Default: false

Render all wiki links as absolute links.

uriSuffix

Default: ``

Append this suffix to every URL.

const html = require('markdown-it')()
  .use(require('markdown-it-wikicustom')({ uriSuffix: '.php', relativeBaseURL: './' }))
  .render('[[Main Page]]')
  // <p><a href="./Main-Page.php">Main Page</a></p>

htmlAttributes

Default: {}

An object containing HTML attributes to be applied to every link.

const attrs = {
  'class': 'wikilink',
  'rel': 'nofollow'
}
const html = require('markdown-it')()
  .use(require('markdown-it-wikicustom')({ htmlAttributes: attrs }))
  .render('[[Main Page]]')
  // <p><a href="Main-Page" class="wikilink" rel="nofollow">Main Page</a></p>

markdown-it-wikicustom's People

Contributors

amdev9 avatar jsepia avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.