Notary Public Mystifier

    @msikma/wiki-ly

    0.1.0 • Public • Published

    MIT license npm version

    Wiki.ly

    Wiki.ly is a fork of Mediawiki's Parsoid project. It's a PEG-based parser that converts wikitext to a Javascript object.

    This particular version of Wiki.ly is a fork of the original by @dan1wang to change the interface for package consumers, and to enable pre-compiling the tokenizer.

    Usage

    To add this package to your project:

    npm i --save "@msikma/wiki-ly"
    

    Example

    A minimal example of running the parser with the default options:

    const { createParser } = require('@msikma/wiki-ly')
    
    const input = `Hello [[world]]!`
    const parser = createParser()
    const output = parser.parse(input)
    
    console.log(output)

    This results in the following output:

    [
      'Hello ',
      SelfclosingTagTk {
        type: 'SelfclosingTagTk',
        name: 'wikilink',
        attribs: [ KV { k: 'href', v: [ 'world' ], vsrc: 'world' } ],
        dataAttribs: { tsr: [ 6, 15 ], src: '[[world]]' }
      },
      '!',
      EOFTk { type: 'EOFTk' }
    ]

    It's possible to pass an object of environment options to the parser, but this is not documented right now. See lib/env.js for more information.

    License

    This project is a fork of Wikimedia's Parsoid, which is licensed under the GPL v2.0.

    The port by @dan1wang is licensed under the MIT license.

    Keywords

    Install

    npm i @msikma/wiki-ly

    DownloadsWeekly Downloads

    4

    Version

    0.1.0

    License

    MIT

    Unpacked Size

    4.96 MB

    Total Files

    54

    Last publish

    Collaborators

    • msikma