@oinkiguana/outline-loader v1.0.2

Outline Loader

A Webpack loader that works with Outline to compile literate JavaScript.

Installation

npm install --save-dev @oinkiguana/outline-loader

Options

• language: Passed to Outline's -l parameter, indicating the language tag to compile with
• style: Passed to Outline's -s parameter to override the automatically detected style
• config: Passed to Outline's -c parameter to specify the path to the Outline.toml file
• entrypoint: Passed to Outline's -e parameter to choose a named entrypoint
• output: Can be set to tangle or weave, to indicate whether to tangle the source (output code) or weave it (output documentation)

Example usage:

index.js

import { myFunction } from './functions.js.tex';

myFunction(3); // => 5

functions.js.tex

\documentclass[11pt,a4paper]{article}

\begin{document}

This module works like this:

\begin{code}
==> Define some functions.
==> Export the functions.
\end{code}

Our function \texttt{myFunction} is used to add two to any input.

\begin{code}[name=Define some functions]
function myFunction(input) {
  return input + 2;
}
\end{code}

Now that all the functions are written, they must be exported.

\begin{code}[name=Export the functions]
export { myFunction };
\end{code}

\end{document}

webpack.config.js

module.exports = {
  entry: 'index.js',
  module: {
    rules: [
      { test: /\.js\.(tex|md|html|bird)$/, loader: 'outline-loader' },
    ],
  },
};