Skip to content

Create markdown-based notebooks stored in Gists with image support

Notifications You must be signed in to change notification settings

flotwig/markdown-notebooks

Repository files navigation

MDNB: Markdown Notebooks

Live at https://mdnb.bloomqu.ist/

Features

Full Markdown Support

MDNB uses Marked to parse your Markdown, so any standard Markdown is supported.

Additionally, there is support for GFM Task Lists:

  • Something to do
  • Something done

GFM tables:

colA colB
0.123 0.456

Inserted image support

Adding screenshots or other images on your clipboard to your notebook can be done by just pasting them into the active notebook:

Pasted image

Or by dragging and dropping them in:

Drag n dropped image

Pages

A notebook can consist of multiple pages. You can create pages, delete pages, and reorder pages by dragging and dropping:

Page stuff

Resizable Panes

The sidebar, editor, and renderer are all resizable:

Resizable panes

Development

To install dependencies, run yarn.

Then, run yarn start to start the app on port 3000.

To test GitHub login, you'll need to supply a client ID and secret from GitHub.com in the GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET environment variables. On Mac and Linux:

GITHUB_CLIENT_ID=your-client-id GITHUB_CLIENT_SECRET=your-client-secret yarn start

To run the Cypress integration tests, do yarn run cypress:open.

To run the unit tests, do yarn run test.

About

Create markdown-based notebooks stored in Gists with image support

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •