flotwig / markdown-notebooks

Create markdown-based notebooks stored in Gists with image support

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:

Or by dragging and dropping them in:

Pages

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

Resizable Panes

The sidebar, editor, and renderer are all resizable:

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.

markdown-notebooks's Issues

Add way to back out of GitHub login dialog, cancel action that caused it

Checkbox rendering support

Please support checkboxes in markdown so the following can be rendered properly.

markdown:

- [x] Done
- [x] Done
- [ ] Not done

render:

• Done
• Done
• Not done

Indicate keyboard shortcuts next to the buttons they control

Add routing

• load a Gist by visiting /username/gistId (match Github gist url format)
• change url appropriately when creating/changing notebooks
• warn user when navigating away w/ unsaved changes (local user preference)

Undo deleting pages

Create an intro notebook for first-time users

Use GitHub styling for code, tables

Add note searching

Could be via a search bar at the top of page list, if there's enough real estate

When saving draft, also save current page

When saving draft, also save cursor location

See #82

Fix tab order of controls

Add page coloring/page front-matter

Similar to how Jekyll does it, allow YAML front-matter in notebook pages to specify (for now) the color that the page will be in the sidebar

Handle concurrent windows better

Currently it looks like markdown-notebooks doesn't handle multiple clients accessing the same gist files well. Simply by having 2 tabs open across my machine, I managed to have this result:

Which seems to result from an out of sync saving functionality

Add visual diffs between draft and loaded version

Remove illegal Gist filename characters from page titles

Add user preferences

• store in localStorage? in custom Gist? on our server?
• add modal for changing
• preferences:
  • showing keyboard shortcuts
  • periodic autosave on/off?
  • button to delete local data and log out/invalidate session
  • 4 spaces or \t character

Investigate gist limits

• is there a limit to the max number of pages in a gist? if so we need to prevent that
• how should it handle gistfiles >1MB? currently it won't work right

Update README

• add build instructions
• add dev instructions
• add .gif of program operation
• add current feature list

Add markdown editor shortcuts

• Ctrl+B to insert bold around current cursor/selection or to end current bold
• Ctrl+I

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Replace dependency babel-eslint with @babel/eslint-parser 7.11.0
• Update dependency postcss-preset-env to v6.7.2
• Update dependency @babel/core to v7.24.6
• Update dependency babel-loader to v8.3.0
• Update dependency case-sensitive-paths-webpack-plugin to v2.4.0
• Update dependency eslint-plugin-import to v2.29.1
• Update dependency eslint-plugin-jsx-a11y to v6.8.0
• Update dependency eslint-plugin-react to v7.34.1
• Update dependency html-webpack-plugin to v4.5.2
• Update dependency mini-css-extract-plugin to v0.12.0
• Update dependency moment to v2.30.1
• Update dependency pnp-webpack-plugin to v1.7.0
• Update dependency redux to v4.2.1
• Update dependency redux-thunk to v2.4.2
• Update dependency resolve to v1.22.8
• Update dependency sanitize-html to v1.27.5
• Update dependency whatwg-fetch to v3.6.20
• Update react monorepo (@types/react, @types/react-dom, react, react-dom)
• Update dependency @blueprintjs/core to v5
• Update dependency @blueprintjs/icons to v5
• Update dependency @svgr/webpack to v8
• Update dependency babel-loader to v9
• Update dependency babel-preset-react-app to v10
• Update dependency bfj to v8
• Update dependency chalk to v5
• Update dependency css-loader to v7
• Update dependency cypress to v13
• Update dependency dotenv to v16
• Update dependency dotenv-expand to v11
• Update dependency eslint to v9
• Update dependency eslint-config-react-app to v7
• Update dependency eslint-loader to v4
• Update dependency eslint-plugin-flowtype to v8
• Update dependency fs-extra to v11
• Update dependency history to v5
• Update dependency html-webpack-plugin to v5
• Update dependency marked to v12
• Update dependency mini-css-extract-plugin to v2
• Update dependency node-sass to v9
• Update dependency optimize-css-assets-webpack-plugin to v6
• Update dependency postcss-flexbugs-fixes to v5
• Update dependency postcss-loader to v8
• Update dependency postcss-preset-env to v9
• Update dependency postcss-safe-parser to v7
• Update dependency react-app-polyfill to v3
• Update dependency react-dev-utils to v12
• Update dependency react-redux to v9
• Update dependency redux to v5
• Update dependency redux-starter-kit to v2
• Update dependency redux-thunk to v3
• Update dependency sanitize-html to v2
• Update dependency sass-loader to v14
• Update dependency style-loader to v4
• Update dependency terser-webpack-plugin to v5
• Update dependency url-loader to v4
• Update dependency wait-on to v7
• Update dependency webpack to v5
• Update dependency webpack-dev-server to v5
• Update dependency webpack-manifest-plugin to v5
• Update react monorepo to v18 (major) (@types/react, @types/react-dom, react, react-dom)
• 🔐 Create all rate-limited PRs at once 🔐

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• Update dependency babel-plugin-named-asset-import to v0.3.8
• Update dependency optimize-css-assets-webpack-plugin to v5.0.8
• Update dependency terser-webpack-plugin to v1.4.5
• Update dependency webpack-dev-server to v3.11.3
• Update dependency @blueprintjs/core to v3.54.0
• Update dependency @blueprintjs/icons to v3.33.0
• Update dependency node-sass to v4.14.1
• Update dependency webpack to v4.47.0
• Update dependency cypress-react-unit-test to v4
• Update dependency file-loader to v6

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency jest-pnp-resolver to v1.2.3
• Update dependency workbox-webpack-plugin to v7
• Update jest monorepo to v29 (major) (babel-jest, jest, jest-resolve)
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

npm

package.json

• @blueprintjs/core 3.36.0
• @blueprintjs/icons 3.16.0
• history 4.10.1
• left-pad 1.3.0
• marked 0.8.2
• moment 2.25.3
• react 16.13.1
• react-app-polyfill 0.2.2
• react-dom 16.13.1
• react-redux 6.0.1
• react-split-pane 2.0.3
• redux 4.0.5
• redux-logger 3.0.6
• redux-starter-kit 0.9.1
• redux-thunk 2.3.0
• sanitize-html 1.23.0
• whatwg-fetch 3.0.0
• @babel/core 7.12.10
• @svgr/webpack 4.3.3
• @types/react 16.9.35
• @types/react-dom 16.9.8
• babel-core 7.0.0-bridge.0
• babel-eslint 10.1.0
• babel-jest 23.6.0
• babel-loader 8.2.2
• babel-plugin-named-asset-import 0.3.6
• babel-preset-react-app 7.0.2
• bfj 6.1.2
• case-sensitive-paths-webpack-plugin 2.3.0
• chalk 2.4.2
• css-loader 2.1.1
• cypress 3.8.3
• cypress-get-react-component 1.0.0-dev4
• cypress-react-unit-test 2.10.0
• dotenv 6.2.0
• dotenv-expand 4.2.0
• eslint 5.16.0
• eslint-config-react-app 3.0.8
• eslint-loader 2.2.1
• eslint-plugin-flowtype 3.13.0
• eslint-plugin-import 2.20.2
• eslint-plugin-jsx-a11y 6.2.3
• eslint-plugin-react 7.20.0
• file-loader 3.0.1
• fork-ts-checker-webpack-plugin-alt 0.4.14
• fs-extra 7.0.1
• html-webpack-plugin 4.3.0
• identity-obj-proxy 3.0.0
• jest 23.6.0
• jest-pnp-resolver 1.0.1
• jest-resolve 23.6.0
• mini-css-extract-plugin 0.9.0
• node-sass 4.13.1
• optimize-css-assets-webpack-plugin 5.0.3
• pnp-webpack-plugin 1.6.4
• postcss-flexbugs-fixes 4.2.1
• postcss-loader 3.0.0
• postcss-preset-env 6.7.0
• postcss-safe-parser 4.0.2
• react-dev-utils 7.0.5
• resolve 1.17.0
• sass-loader 7.3.1
• style-loader 0.23.1
• terser-webpack-plugin 1.4.3
• url-loader 1.1.2
• wait-on 3.3.0
• webpack 4.41.2
• webpack-dev-server 3.11.0
• webpack-manifest-plugin 2.2.0
• workbox-webpack-plugin 3.6.3

---

• Check this box to trigger a request for Renovate to run again on this repository

Better handle errors in image uploading

Add error checking for stored auth token on load

Support vertical layout as well as horizontal layout

Rn it looks weird on portrait monitors:

Would be nice if the panes could stack atop each other.

#63

Include pasted/dropped image filename in alt text

Fix: image uploading breaks if user changes page while upload in progress

Make open dialog better

• make it filterable by name
• maybe don't show things that probably aren't notebooks based on the filenames in them? by default, turn off w/ user preference?
• pagination & preload a sufficiently high number of gists to search through
• add error checking to open dialog + open notebook

Figure out why textarea is small for some people but not for others

Allow resizing/hiding panes

If user does not match gist author, grey out Save, make Save As required

Add links to GFM reference or in-app reference (gist?)

Move controls to top bar

This is too big. Move all the controls, maybe even the page list somehow to a top nav bar where it will be easier to condense + add new stuff

Full support for GFM syntax highlighting

console.log('like this')

Fix image formatting

Max width should be 100%

Add the ability to draw and insert simple images?

Might be a bit much, but if some lightweight drawing app can be embedded on-the-fly don't see why not

Use markdown sourcemaps to autoscroll the source when the HTML is clicked, and vice versa

When {enter} is pressed on the page/notebook titles, focus should move to the next element

• this
• also change focus to title when page is created anew

Fix page list scrolling

Gets pretty ugly once the page list begins to overflow:

Add links to share your notebook for viewing on Gist itself

Pages are not saved unless text is present

Pages are lost if there is no text content in the page, even if the "No unsaved changes" icon is present. Only pages with text content are saved

Disable page controls while saving

Or mark unsaved if they started editing after starting a save