Skip to content

Latest commit

 

History

History
181 lines (167 loc) · 7.56 KB

bzWiki-spec.md

File metadata and controls

181 lines (167 loc) · 7.56 KB

bzWiki

  • markdown wiki / scripting / macro => kind of ... tiddlywiki, evernote
  • bzMemo / bzNote

Implementation

  • markdown native format

  • [backend] directory tree with limited (very less) payload files

  • editor / preview

  • preview ??

  • editor ??

    • regex find / replace

Frontend

  • browser extension
    • to hack on markdown content (not only local files)
  • served by backend
  • local html & javascript

Backend

  • node.js local file server (http)
  • live reload
  • more file adaptors as 2nd stage

Features

Editor

  • markdown native format
  • github / gitlab / HackMD / CodiMD like operation & rendering
  • (0.1) preview / edit mode ??
  • User Interface
    • flexiable window
    • single / tabbed document
      • (0.2) native by browser
      • (advanced) auto collect tabs
    • (0.5) separate edit / preview window
    • (0.8) by wiki scripting
    • multi page / tabbed / (0.1) standlone page ev
    • (0.5) window tile / cascade
  • spell check ev [cr]
  • (0.4) drag-n-drop as title/link (or text paste ?) ev
  • regex find / replace
  • clipboard / snippet collection

File / Organize

  • [backend] directory tree with limited (very less) payload files
  • outline
  • back / forward browsing ev
  • (0.1) directory tree browsing ev
    • quick move to (with folder search/suggestion) ev
  • (0.2) multiple root directory for different realm
  • smart folder / search (virtual) folder
    • [backend] (auto?) soft link to .md in different folder (e.g. code dev repo)
  • (0.2) auto include related img
    • img / attachment side panel => hover to show
    • auto sorting
    • auto invlude (template): default / no default / top / bottom
  • (0.4) thumbnail / card / list view / sorting ev
  • (0.6) blog archive (sync ?)
  • persistent link td
  • backup / versioning

Sync / Sharing

  • sync (with cloud drive / syncthing) ev
  • sharable link ev, helped by Dropbox or other cloud

Tag / meta / search

  • [backend]/[frontend] full text search ev, link suggestion vd [cr]
  • tagging ev td / realm
  • toc/file meta:
    • create date:
    • modify date: (auto change)
    • tag

Hackable

  • flow chart - mermaid.js
  • [backend] robust wiki reference (smart search missing link)
  • smart link/filename conversion ??
  • over/under-scroll to see some context
  • Hackable (Scriptable) td
  • (0.3) scripting / macro td
    • embed snippet
      • embedmd: embed code into markdown (with regexp)
    • todo list vd
    • dynamic summary table
    • auto generated/update md2 files
    • local / global setting
  • Import Data (digest) from Web [xl] / Web scraping
  • js REPL console / data persistence
  • yaml, json => data analytic

Platform / Dependency

Roadmap

  • version (0.x) listed as above

Readiness

  • (20%) pre-alpha (experimental)
  • (40%) alpha (indev, buggy)
  • (60%) pre-beta (basic function)
  • (80%) beta (for daily use)
  • (80%)~(100%) test/improve

Ref:

  • my previous markdown bZmd-new, (loca)bZmd-new
  • [gh] github / gitlab
  • [hk] HackMD / [cd] CodiMD -- online edit / preview
  • [cr] Chrome
  • [xl] Excel
  • stackedit
  • Markdown syntax cheatsheet

css_templates

Benchmark


(Hackable)

TiddlyWiki


(Edit/Preview)

Evernote

  • https://evernote.com
  • ** sync PC / mobile
  • ** sharable link
  • -- DB, but not files, only 2-layer folder
  • -- not hackable
  • -- only one main window, not good switching among search / browsing

Vscode

  • Visual Studio Code - https://code.visualstudio.com/
  • ** locale files
  • -- not for browsing / wiki
  • -- no single page mode
  • -- less feature for file meta: tag / date

stackedit

  • ttp://stackedit.io
  • in browser, with
  • ** multiple cloud => Google Drive, Dropbox, GitHub, Gitlab

notable

Chrome Extension - search markdown