Skip to content

Markdown Graph Notes App. Taking notes in markdown and generating diagram from script

Notifications You must be signed in to change notification settings

xu4wang/markgraph

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markgraph

Markgraph stands for Markdown Graph Notes.

Live Demo is avalable here!

Please find a number of key features below:

  • Markdown

    • Markdown for writing document.
  • Graph

    • Mermaid to draw diagrams
    • Connect nodes to draw complex diagrams.

    Each document is a node, one node can have a number of sub nodes. The subnodes can be connected via arrows in different color, style etc.

  • Notes

    • There is no server needed. The app is a single page app running in your browser.
    • Every keystroke will be saved within one second.
    • Git like time machine to keep changes saved as snapshots, you can always go back to a previous snapshot.
    • Easy to import and export via a single text file.
    • Easy to share the document via an URL.

Terms used in markgraph

Workspace : All the document you can access in markgraph UI. In the workspace, there is at least one Notes.

Notes : A collection of document. There maybe several notes in the workspace. You can switch by selecting in the explorer.

Node : A node is a document. It can have sub nodes ( sub documents) too.

Snapshot : A copy of the workspace.

Explorer : A list view to show notes in current workspace, or nodes under current notes.

Editor : An area for editing node.

Canvas : The area to show the preview version of the node.

Outline : Showing a list of nodes, click on one item will jump to that node.

User's Manual

The Manual itself is created using markgraph, and it is available online.

Please find below some screen capture of the manual.

architecture tasks markgraph mermaid import share

About

Markdown Graph Notes App. Taking notes in markdown and generating diagram from script

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published