https://github.com/hrbigelow/md-to-webpage

Compile a markdown file exported from Jupyter to a webpage. Supports syntax highlighting of code blocks and inline or block math mode using Katex
https://github.com/hrbigelow/md-to-webpage

Last synced: 4 days ago
JSON representation

Compile a markdown file exported from Jupyter to a webpage. Supports syntax highlighting of code blocks and inline or block math mode using Katex

• Host: GitHub
• URL: https://github.com/hrbigelow/md-to-webpage
• Owner: hrbigelow
• Created: 2023-09-22T16:51:56.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-15T18:55:48.000Z (about 1 year ago)
• Last Synced: 2023-10-16T17:43:21.026Z (about 1 year ago)
• Language: JavaScript
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Introduction

md-to-webpage is a tool for turning Markdown code with embedded math and

syntax-highlighted code blocks into a webpage.

# Quick Start

This assumes you have a `path/to/notebook.ipynb` that you want to turn into a

webpage.

```bash

git clone https://github.com/hrbigelow/md-to-webpage

cd md-to-webpage/esbuild-plugin-markdown

node build.js

cd md-to-webpage

npm install -D ./esbuild-plugin-markdown

npm install

jupyter nbconvert --to markdown path/to/notebook.ipynb --output content.md

# This will build www/main.js and www/main.js.map

# Will output the localhost:port where you can view your webpage

# To deploy, copy www to a webserver

node script.mjs

```

By default, this includes python and bash code blocks.  See `main.js` to add more.