Basic

You can click on Markdown links.
You can click on Markdown checkboxes.
You can use ⌘ + [ / ⌘ + ] to outdent / indent text.
You can use ⌥ + Click to position the cursor, even on links.
You can use ⌘ + Click to add multiple cursors.
You can use ⌥ + Drag to select a rectangle area.
You can use ⌘ + Drag to select multiple areas.
You can use the middle button on mouse to open links in new tab.

File (#file)

Files start with a hashtag (#) in the URL / link.

• Default notepad
  • home: a special notepad
• Built-in notepads (readonly)
  • list*: a pad to list all your files
  • readme*: documentation
  • preferences*: preferences
  • sample*: sample file
• Create your own notepad
  • whatever_you_want

Action (?action)

Actions start with a question mark (?) in the URL / link, and use = to pass parameters.
Actions will be removed from URL automatically.
Actions can be attached to files.
Actions may change / override contents.

• Built-in actions
  • create a blank file
  • load a github gist
• Attach to files
  • create a blank file "foo"
  • load a github gist as file "foo"

Mode (#file?mode)

A mode is a pre-defined way to view files, so modes must be attached to files.
Modes will stay in URL, but won't be stored anywhere.
So if you click a link or open another file, current mode will be gone.
If you want to use a mode as default option, use settings below.

• View modes
  • editor mode
  • reading mode
  • split mode
• Themes
  • dark
  • light
• Other settings
  • big
  • normal
  • bascially all settings can attach to files as a mode.

Settings (set:option)

Settings change preferences globally and persistently.
Settings do not work in URL.
Settings can be override (locally) by modes.

• View settings
  • split
  • editor
  • reader
• Themes
  • dark mode
  • light mode
• Other settings
  • check out the Perferences page.
  • you can also use the developer console to change preferences :)

Examples

• Read a file
  • sample
  • sample without LaTeX
• Edit / read a gist
  • reader
  • edit
  • reader (SVG)
  • you can even use "gist + links + reader" to make an ebook and share.

Feature list

• minimal UI
• Markdown highlighting
• code highlighting
• LaTeX support
• clickable links
• split view (side by side)
• read view (HTML only)
• alt + click to localize cursor
• cmd + click to use multiple cursors
• middle button to open link in new tab
• auto-saving notes
• auto-saving settings
• separated file store
• file list
• modes / actions / settings in URL
• settings in console
• character, word, line counter
• light / dark mode
• line number
• small / normal / big UI sizes
• cmd / ctrl + s to save .md file
• gist view
• todo list
• browser scaling friendly
• print command
• improved print styles

Raw thoughts

• plugins / themes
  • install via GET access
  • encoded with base64
  • how to authorize
  • security
  • abstraction
  • for themes, DSL (JSON) is enough
    • i.e. mak.shud.in?install_theme=eyJuYW1lIjoibG9yZW0gaXBzdW0iLCJiZ0NvbG9yIjoicmVkIn0=
    • doable
    • fonts
    • too long for GET?
• ~~hijack uncaught console error~~
  • for typos in settings
    • i.e. Uncaught ReferenceError: dar is not defined at :1:1
    • show a suggestion like you may wanna try "dark"?
  • ~~proxy~~
  • ~~getter~~
  • impossible
• latex
  • katex
  • preview is necessary
• code highlighting
• checkbox
  • to-do list
• spellcheck
• monospace (fixed width) toggle
  • fonts
    • pt mono
    • menlo
    • fira code
    • andale mono
    • courier
• b&w mode, focus mode, etc..
  • what is FOCUS WRITING?
  • false requirements?
• dnd
  • drag files
    • markdown, raw text
    • image (insert)
  • drag to insert text
    • link detection
• share
  • do we really need a backend?
  • webrtc
  • URL schema, levels
  • firebase
• simple collaborate
  • try webrtc
  • conflicts
• put data in URL
  • https://jbt.github.io/markdown-editor
  • why?
• gist reader
  • override original pad?
  • editable?
• reader + pagination
  • A4 paper view (like PDF)
• add to home screen (iOS)
• remove settings when version changed
  • maintain a version number in settings

By Shu ([email protected]), SH 2017
http://mak.shud.in