node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

rebber-plugins

rebber-plugins Build Status Coverage Status

rebber-plugins is a collection of LaTeX stringifiers for custom mdast nodes. These plugins are intended to be used with rebber.

It currently supports:

Installation

npm:

npm install rebber-plugins

Usage

const unified = require('unified')
const remarkParser = require('remark-parse')
const rebber = require('rebber')
 
const {contents} = unified()
  .use(remarkParser, remarkConfig)
  .use(rebber, rebberConfig)
  .processSync('### foo')
 
console.log(contents);

Supported remark plugins

remark-abbr
  • remarkConfig needs to be configured for remark-abbr
  • rebberConfig.overrides.abbr = require('rebber-plugins/dist/type/abbr')
  • rebberConfig.abbr = (displayText, definition) => ''
remark-align
  • remarkConfig needs to be configured for remark-align
  • rebberConfig.overrides.centerAligned = require('rebber-plugins/dist/type/align')
  • rebberConfig.overrides.leftAligned = require('rebber-plugins/dist/type/align')
  • rebberConfig.overrides.rightAligned = require('rebber-plugins/dist/type/align')
  • rebberConfig.leftAligned = (innerText) => ''
  • rebberConfig.centerAligned = (innerText) => ''
  • rebberConfig.rightAligned = (innerText) => ''
  • rebberConfig.defaultType = (innerText, type) => ''
remark-custom-blocks
  • remarkConfig needs to be configured for remark-custom-blocks
  • rebberConfig.overrides.errorCustomBlock = require('rebber-plugins/dist/type/customBlocks')
  • rebberConfig.errorCustomBlock = (innerText, environmentName) => ''
remark-emoticons
  • remarkConfig needs to be configured for remark-emoticons
  • rebberConfig.overrides.emoticon = require('rebber-plugins/dist/type/emoticon')
  • rebberConfig.emoticons = remarkConfig.emoticons
remark-grid-tables
  • remarkConfig needs to be configured for remark-grid-tables
  • rebberConfig.overrides.gridTable = require('rebber-plugins/dist/type/gridTable')

Proper handling of fenced code blocks in grid tables being hard to achieve in LaTeX, you can use the following preprocessor to automatically move the code blocks to an appendix section and replace the original location with a reference to the appendix section:

  .use(rebber, {
    preprocessors: {
      iframe: require('rebber-plugins/dist/preprocessors/iframe')
    }
  })
remark-iframes
  • remarkConfig needs to be configured for remark-iframes

iframe nodes require some preprocessing before getting compiled to LaTeX:

const unified = require('unified')
const remarkParser = require('remark-parse')
const rebber = require('rebber')
 
const {contents} = unified()
  .use(remarkParser, {
    // see config options in the remark-iframes package
    iframes: {
      'www.dailymotion.com': {
        tag: 'iframe',
        width: 480,
        height: 270,
        disabled: false,
        replace: [
          ['video/', 'embed/video/'],
        ],
        thumbnail: {
          format: 'http://www.dailymotion.com/thumbnail/video/{id}',
          id: '.+/(.+)$'
        }
      },
    }
  })
  .use(rebber, {
    preprocessors: {
      iframe: require('rebber-plugins/dist/preprocessors/iframe')
    }
  })
  .processSync('some markdown')
 
console.log(contents);
remark-kbd
  • remarkConfig needs to be configured for remark-kbd
  • rebberConfig.overrides.kbd = require('rebber-plugins/dist/type/kbd')
remark-sub-super
  • remarkConfig needs to be configured for remark-sub-super
  • rebberConfig.overrides.sub = require('rebber-plugins/dist/type/sub')
  • rebberConfig.overrides.sup = require('rebber-plugins/dist/type/sup')

License

MIT © Zeste de Savoir