mdnb - npm explorer

:warning: PRE-ALPHA, SEEKING INPUT :warning:

mdnb is a markdown notebook with plotly and mathjax support. Something between mdbook and jupyter. It works on an airplane.

``bash git clone https://github.com/pbrandt1/mdnb.git cd mdnb npm link mdnb`

See mdnb --help for command line options, including -p for http port.

`Installation`

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js.

Installation is done using the npm install command:

`bash $ npm install -g mdnb`

`Features`

- Github-flavored Markdown - The javascript blocks actually run in your browser - Plotly support - MathJax support - emojione for a consistent emoji experience :woman_facepalming:

`Examples`

screenshots please

`Customization`

Here's a default mdnb.json. Change what you will.

`json { "port": 8080,

"title": "mdnb", "favicon": "favicon.png", "custom-css": "mdnb-theme.css", "custom-head": "mdnb-head.html",

"MathJax": { "tex2jax": { "inlineMath": [["$","$"], ["\$","\$"]] } }, "ignore": [ "node_modules", ".git" ] }

Copy the default mdnb.json file and change what you want. Put it in the root directory of your thing. If you don't want to clutter your root, you can use the -f option, like mdnb -f "some/config/file.json".

You probably know some css. Probably more than me. I'd say you should dive in and override whatever you want.

TODO provide some copy-pasta

`css / change theme color / pre { border-color: #000000; }``

Really major cusotmization

Just fork the repo and go nuts.

Tests

Tested by highly trained primates in North America.

Contributing

Contribute in whatever way you seem appropriate. Just be nice.

Things that make it work

- Showdown
- MathJax
- plotly.js
- Highlight.js
- express
- socket.io
- Milligram
- Public Sans
- Source Code Pro
- emojione
- node.js

Similar things

- mdbook
- mkdocs
- md-page
- Jupyter

License

MIT

todo

- [x] mathjax offline
- [x] command line options
- [x] make demo plotly
- [x] make the navbar scroll and stuff
- [x] make the hamburger menu work
- [x] add options for title and make index.html a template
- [x] allow custom css somehow
- [x] allow loading custom header html
- [ ] add screenshots to readme, show live reloading
- [ ] html inside markdown

Customization

Here's a default mdnb.json. Change what you will.

json
{
  "port": 8080,

  "title": "mdnb",
  "favicon": "favicon.png",
  "custom-css": "mdnb-theme.css",
  "custom-head": "mdnb-head.html",

  "MathJax": {
    "tex2jax": {
      "inlineMath": [["$","$"], ["\\(","\\)"]]
    }
  },
  
  "ignore": [
    "node_modules",
    ".git"
  ]
}

Copy the default mdnb.json file and change what you want. Put it in the root directory of your thing. If you don't want to clutter your root, you can use the

-f option, like mdnb -f "some/config/file.json".

You probably know some css. Probably more than me. I'd say you should dive in and override whatever you want.

TODO provide some copy-pasta

css
/ change theme color /
pre {
    border-color: #000000;
}

todo