Skip to content

Markdown to Wolfram Notebook converter

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

ConnorGray/md2nb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

md2nb

Crates.io License

md2nb is a command-line tool for converting Markdown files into Wolfram Notebooks.

Diagram showing md2nb conversion of Markdown files to Wolfram Notebooks

Usage

md2nb is a command-line tool. After installing md2nb, it can be used to convert a .md file to a .nb:

$ md2nb <INPUT>.md <OUTPUT>.nb

For example, to convert this project's README.md file into a Wolfram Notebook, execute:

$ md2nb README.md README.nb

Features

md2nb converts .md files into Wolfram .nb files.

Markdown constructs are converted into corresponding standard Wolfram Notebook representations.

Most CommonMark features are supported, including:

  • Text styles like emphasis and italics
  • Links
  • Headers
  • Bulleted lists
  • Code blocks
  • Block quotes
  • Tables
  • Horizontal rules

Additionally, some Markdown features are converted into Wolfram Notebook representations that are more interactive than typical rendered Markdown:

  • Code blocks containing code written in a language supported by ExternalEvaluate will be converted to external language cells, which can be executed directly within the Wolfram Notebook.

Examples

See the 'Kitchen Sink' example, which includes samples of all Markdown features currently supported by md2nb.

Installation

Using cargo

md2nb can be installed using cargo (the Rust package manager) by executing:

$ cargo install md2nb

This will install the latest version of md2nb from crates.io.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

Markdown to Wolfram Notebook converter

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

No packages published

Languages