siyuan/README_en_US.md
2020-09-27 09:23:46 +08:00

4.9 KiB

SiYuan
When one drinks water, one must not forget where it comes from

中文

💡 Introduction

SiYuan is a desktop Markdown Block-Reference and Bidirectional-Link note-taking application, supports Windows, Mac and Linux.

Welcome to SiYuan Official Discussion Forum to learn more.

Features

  • Born for Markdown
    • Support Instant Rendering, users familiar with Typora should not be unfamiliar, in theory this is the most elegant Markdown editing method
    • 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
      • Whether to enable ==Mark== 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
  • Content block
    • Block-level quotes and two-way links
    • Document relationship diagram, global relationship diagram
    • Bookmark collection
  • Hierarchical tag
  • Multi-window, multi-tab, drag and drop to split screen
  • WebDAV
  • Fulltext search
  • Themes and icons
    • Built-in bright and dark themes
    • Built-in two sets of icons, Material and Ant Design
    • Support custom themes and icons
  • Export
    • Standard Markdown export
    • Content block quote provides anchor text + embedded Blockquote option
    • Copy to WeChat public account, Zhihu

🗺️ Roadmap

📸 Screenshots

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

Roam

roam.gif

Light theme

light.png

Dark theme

dark.png

Markdown Options

md.png

search.png

Block

block.png

Block Reference

blockref.png

🛠️ Download Setup

📜 Documentation

🏘️ Community

🙏 Acknowledgement