bebetter / liandi

📕 A desktop Markdown note-taking application, supports Windows, Mac and Linux. 一款桌面端的 Markdown 笔记应用，支持 Windows、Mac 和 Linux。

LianDi Note, connect every bit

中文

💡 Introduction

LianDi Note is an open source desktop note application that supports Windows, Mac and Linux.

Welcome to LianDi Note Official Discussion Forum to learn more.

✨ Features

• Born for Markdown
  • Support three editing modes
    • WYSIWYG: It is more friendly to users who are not familiar with Markdown, and you can use it seamlessly if you are familiar with Markdown
    • Instant Rendering: users familiar with Typora should not be unfamiliar, in theory this is the most elegant Markdown editing method
    • Split View: suitable for Markdown editing on large screen
  • Support mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staffs, etc.
  • Markdown text formatting
  • Paste HTML automatically converted to Markdown
  • Configure Markdown to analyze detailed rendering parameters
    • Whether to enable footnote support
    • Whether to enable [ToC] support
    • Do you need to insert spaces between Chinese and Western languages ​​automatically
    • Whether to perform automatic term correction
    • Punctuation such as Chinese followed by English comma period is automatically replaced with Chinese corresponding punctuation
    • Does inline math formula allow starting $ followed by numbers
    • Math formula engine switching MathJax, KaTeX
• WebDAV mount remote directory
• Double Shift quick navigation
• Fulltext search
• Light and dark themes
• Tag aggregation category TBD
• Export static site, built-in multiple sets of themes TBD

📸 Screenshots

WYSIWYG

WYSIWYG mode is more friendly to users who are not familiar with Markdown, and you can use it seamlessly if you are familiar with Markdown.

Instant Rendering

Instant Rendering mode should not be unfamiliar to users who are familiar with Typora. In theory, this is the most elegant Markdown editing method.

Split View

The traditional Split View mode is suitable for Markdown editing on a large screen.

Light theme

Dark theme

Markdown Options

Fulltext search

🛠️ Setup

Installation package

• GitHub
• Gitee
• Local download

Source building

1. Install Go, Node environment
2. Run the build script in the root directory of the project
3. After the build is successful, the installation package will be generated under app / build

If you want to modify the source code, please set up the development environment as follows:

1. Build the kernel under the kernel directory and start
   • Windows: go build -o kernel.exe && kernel.exe
   • Mac: go build -o kernel-darwin &&. / Kernel-darwin
   • Linux: go build -o kernel-linux &&. / Kernel-linux
2. Build the frontend npm run dev in the app directory and start the main process npm run start

🏗️ Technology Architecture

• Realize the main process through Electron, and pull up the kernel process implemented by golang after startup
• The kernel realizes the interaction between the WebSocket server and the main process
• The kernel implements WebDAV server and client
• File access (including operation of local files) through WebDAV client
• Markdown files are loaded into memory when starting and mounting to achieve full-text search
• Achieve Markdown WYSIWYG editing mode with Vditor editor

📜 Documentation

• LianDi Note - an open source desktop note application that supports Windows, Mac and Linux
• LianDi Note roadmap

🏘️ Community

• Forum
• Issues

📄 License

LianDi Note uses the Mulan Permissive Software License，Version 2 open source license.

🙏 Acknowledgement

• Vditor - Browser-side Markdown editor
• Lute - A structured Markdown engine that supports Go and JavaScript
• GoWebDAV - Go WebDAV client lib
• Gulu - Go commons utilities
• Gin - Go Web framework
• Melody - Go WebSocket framework
• Electron - Build cross-platform desktop apps with JavaScript, HTML, and CSS