Skip to content

beZong/bZmd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bZmd -- beZong Markdown

Preview markdown files, when editing with (virtually) any editors.

demo

Motivation

Inspired by Grip (GitHub Readme Instant Preview)

In order to manipulate several markdown files, a handy viewer might be even useful than editors. Also, a viewer will be ealier to implement, and to add features, such as,

  • auto fetch active markdown files
    • single executive instance for multiple wikis
    • no necessary the default readme.md file name
    • no need to specify xxxx.md file name
  • adopt for poor-linked wiki

Planned Features

  • (50%) Render GitHub/GitLab Flavored Markdown
    • (70%) GitHub markdown API -- require network connection
      • need check Table styles
    • offline markdown parser -- as fallback when no network connection
    • (70%) Strike.IE -- to render GitHub-flavored markdown offline
    • (50%, pending) MarkdownSharp, no table support
    • customize CSS, (10%~70%) GitHub style CSS
    • GitLab style CSS
  • Flexible Markdown converter
    • Pandoc -- universal document converter
    • Allow user to select different render backend
  • Fetch active markdown files from other editors, including:
    • (80%) Notepad++
    • (80%) PSPad ...
    • (50%) Visual Studio -- not hooked file saving ??
    • (?) SharpDevelop
    • ... allow user to add other programs
    • clipboard (for browsing)
    • (70%) file explorer (for browsing) ...
  • Monitor changes for (60%) files and directory tree
    • (80%) remember scroll position while refreshing preview
      • todo, first, stat = 14
    • sync scrolling
  • Tabbed document interface (DockUI)
    • (40%) for multiple markdown files
    • optional always-on-top
    • markdown syntax help in a separate tab
    • rename ambiguous tabs
    • lock tab, max tab count
  • Link / Browsing
    • (60%) Web link in browser -- not working in debug mode ??
    • (80%) File link in another tab, or
    • System default application
    • (80%) Show link URL in status bar
    • Handle broken link while navigating
    • Fix broken link in markdown file
  • Browser context menu and shortcut
    • Copy
      • (80%) selected html (Ctrl-C)
      • selected markdown
    • (80%) Zoom in, Zoom out (Ctrl-scroll-up/down)
    • restore default zoom
  • Export HTML
    • (60%) to clipboard - by Ctrl-C
    • (70%) save as file
    • (70%) with style CSS
    • (70%) without styles
  • Full text search acorss files
  • Window location
    • Side By side, auto docking
    • auto hide
  • As a member of beZong -- organize your digital belongings
  • support html and other format

Coding Reference

Markdown

Strike.IE

MarkdownSharp

Windows API

User Interface