GithubHelp home page GithubHelp logo

bebetter / liandi Goto Github PK

View Code? Open in Web Editor NEW

This project forked from 88250/liandi

0.0 1.0 0.0 1.12 MB

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

Home Page: https://hacpai.com/tag/liandi-biji

License: Other

HTML 1.91% JavaScript 10.32% TypeScript 47.28% CSS 7.93% Batchfile 0.38% Shell 0.31% Go 31.86%

liandi's Introduction

LianDi
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.

vditor-wysiwyg

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.

vditor-ir

Split View

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

vditor-sv

Light theme

light.png

Dark theme

dark.png

Markdown Options

markdown.png

Fulltext search

search.png

🛠️ Setup

Installation package

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

arch.png

  • 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

🏘️ Community

📄 License

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

🙏 Acknowledgement

liandi's People

Contributors

88250 avatar vanessa219 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.