yn
A highly extensible Markdown editor. Version control, AI Copilot, mind map, documents encryption, code snippet running, integrated terminal, chart embedding, HTML applets, Reveal.js, plug-in, and macro replacement.
Top Related Projects
📝A simple and elegant markdown editor, available for Linux, macOS and Windows.
Community plugins list, theme list, and releases of Obsidian.
Universal markup converter
The Markdown-based note-taking app that doesn't suck.
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
Quick Overview
Yn is a lightweight, elegant Markdown editor and knowledge management tool. It offers a distraction-free writing experience with features like real-time preview, file management, and support for various plugins. Yn is designed to be a versatile tool for note-taking, documentation, and personal knowledge management.
Pros
- Clean and intuitive user interface
- Supports various plugins and extensions
- Cross-platform compatibility (Windows, macOS, Linux)
- Offers both local storage and cloud sync options
Cons
- Limited collaboration features compared to some other note-taking apps
- Requires some technical knowledge for advanced customization
- May lack some specialized features found in more niche-specific tools
Getting Started
- Download the latest release from the GitHub releases page.
- Install the application on your system.
- Launch Yn and create a new note or open an existing Markdown file.
- Start writing in the editor pane and see the real-time preview in the adjacent pane.
- Explore additional features through the menu options and settings.
For more detailed instructions and documentation, visit the official Yn website.
Competitor Comparisons
📝A simple and elegant markdown editor, available for Linux, macOS and Windows.
Pros of MarkText
- More mature project with a larger community and contributor base
- Cross-platform support for Windows, macOS, and Linux
- Extensive features including table of contents, math equations, and diagrams
Cons of MarkText
- Larger application size and potentially higher resource usage
- Less focus on cloud synchronization and collaboration features
- Steeper learning curve for advanced features
Code Comparison
MarkText (main renderer process):
import { ipcRenderer } from 'electron'
import Vue from 'vue'
import VueElectron from 'vue-electron'
import App from './app'
Vue.use(VueElectron)
new Vue(App).$mount('#app')
Yn (main entry point):
import { app, BrowserWindow } from 'electron'
import { createWindow } from './window'
app.on('ready', () => {
createWindow()
})
Both projects use Electron for desktop application development, but MarkText utilizes Vue.js for its user interface, while Yn appears to have a more lightweight approach. MarkText's code suggests a more complex architecture with additional dependencies, which aligns with its broader feature set. Yn's code indicates a simpler structure, potentially leading to faster performance and easier maintenance.
Community plugins list, theme list, and releases of Obsidian.
Pros of Obsidian-releases
- More established and widely adopted note-taking application
- Extensive plugin ecosystem with a large community of developers
- Robust offline functionality and local file storage
Cons of Obsidian-releases
- Closed-source core application, limiting customization options
- Less flexible in terms of deployment and self-hosting capabilities
- Steeper learning curve for advanced features and customization
Code Comparison
While both projects are primarily focused on note-taking and knowledge management, their codebases differ significantly due to their architectural approaches.
Yn (JavaScript/TypeScript):
import { defineComponent } from 'vue'
import { useI18n } from 'vue-i18n'
export default defineComponent({
setup() {
const { t } = useI18n()
// Component logic
}
})
Obsidian-releases (TypeScript):
import { Plugin } from 'obsidian'
export default class MyPlugin extends Plugin {
async onload() {
// Plugin initialization
}
// Plugin methods
}
The code snippets highlight the different frameworks and approaches used by each project. Yn utilizes Vue.js for its user interface, while Obsidian plugins are built using a custom plugin API provided by the Obsidian core application.
Universal markup converter
Pros of Pandoc
- Extremely versatile, supporting a wide range of input and output formats
- Robust command-line interface with extensive options for customization
- Well-established project with a large community and extensive documentation
Cons of Pandoc
- Steeper learning curve, especially for non-technical users
- Requires installation and command-line usage, which may be intimidating for some
- Less focus on real-time preview and WYSIWYG editing
Code Comparison
Pandoc (command-line usage):
pandoc input.md -o output.html
pandoc input.docx -t markdown -o output.md
Yn (JavaScript API):
import Yn from 'yn'
const yn = new Yn()
yn.render(markdownContent)
Summary
Pandoc is a powerful and versatile document converter with a wide range of supported formats and extensive customization options. It excels in command-line usage and is well-suited for complex document conversion tasks. However, it may be less user-friendly for those unfamiliar with command-line tools.
Yn, on the other hand, is a more focused Markdown editor and previewer with a simpler interface. It offers real-time preview and WYSIWYG editing, making it more accessible for users who prefer a graphical interface. While it may not have the extensive format support of Pandoc, it provides a more streamlined experience for Markdown-centric workflows.
The Markdown-based note-taking app that doesn't suck.
Pros of Notable
- More mature project with a larger community and contributor base
- Offers a desktop application for multiple platforms (Windows, macOS, Linux)
- Supports attachments and file embedding within notes
Cons of Notable
- Less frequent updates and slower development cycle
- More complex setup and configuration process
- Limited customization options compared to Yn
Code Comparison
Notable (JavaScript):
import * as React from 'react';
import {render} from 'react-dom';
import App from './components/app';
render(<App />, document.getElementById('app'));
Yn (TypeScript):
import { createApp } from 'vue'
import App from './App.vue'
import './index.css'
createApp(App).mount('#app')
Both projects use modern web technologies, but Notable is built with React while Yn uses Vue.js. Yn's codebase is written in TypeScript, which may provide better type safety and developer experience.
Notable offers a more traditional note-taking experience with a focus on simplicity and ease of use. It's better suited for users who prefer a standalone application and don't require extensive customization.
Yn, on the other hand, provides a more flexible and customizable environment, making it ideal for developers and power users who want to tailor their note-taking experience. It also offers faster development and more frequent updates, but may have a steeper learning curve for non-technical users.
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
Pros of Logseq
- Open-source with a larger community and more frequent updates
- Advanced graph view for visualizing connections between notes
- Supports both Markdown and Org-mode syntax
Cons of Logseq
- Steeper learning curve due to its unique structure and features
- Less focus on WYSIWYG editing compared to Yn
- Limited theming options out of the box
Code Comparison
Logseq (ClojureScript):
(defn get-block-property [block property-name]
(get (:block/properties block) property-name))
(defn get-page-property [page-name property-name]
(let [page (db/entity [:block/name page-name])]
(get-block-property page property-name)))
Yn (TypeScript):
export function getBlockProperty(block: Block, propertyName: string): any {
return block.properties?.[propertyName];
}
export function getPageProperty(pageName: string, propertyName: string): any {
const page = db.getPage(pageName);
return getBlockProperty(page, propertyName);
}
Both projects aim to provide note-taking and knowledge management solutions, but they differ in their approach and target audience. Logseq offers a more structured, graph-based system with advanced features, while Yn focuses on simplicity and ease of use with its WYSIWYG editor. The code comparison shows similar functionality implemented in different languages, reflecting the distinct tech stacks of each project.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Yank Note
A highly extensible Markdown editor, designed for productivity. Download | Try it Online >>>
English | ä¸æ说æ | Ð ÑÑÑкий
[toc]{level: [2]}
Highlights
- Easy to use: Use Monaco kernel, optimize for Markdown editing, and have the same editing experience as VSCode.
- Powerful: Support version control; Applets, runnable code blocks, tables, PlantUML, Drawio, macro replacements, etc., can be embedded in the document; support for OpenAI auto completion.
- High compatibility: Data is saved as local Markdown files, and the extension functions are implemented in the original syntax of Markdown as far as possible.
- Plug-in extension: Support users to write their own plug-ins to expand the functionality of the editor.
- Encryption supported: Use encryption to save private files such as account number, and the password can be set separately for each file.
Attention
- For more extendable, Yank Note sacrifices security protection (command execution, arbitrary file reading and writing). If you want to use it to open a foreign Markdown file, â ï¸be sure to carefully identify whether the content of the file is trustworthyâ ï¸.
- The encryption and decryption of encrypted files are both completed at the front end. Please be sure to remember your password. Once the password is lost, it can only be cracked violently.
Characteristic functions
For more information on how to use the following functions, please see characteristic functions description
- Sync scrolling: the editing area and the preview area scroll synchronously, and the preview area can be scrolled independently
- Outline: quickly jump to the corresponding location of the document through the directory outline in the preview area
- Version Control: Support backtracking document history versions
- Encryption: files ending with
.c.md
are treated as encrypted files - Auto-save: automatically save files after editing, with orange title bar reminder for unsaved files (encrypted documents are not automatically saved)
- Editing: automatic completion of list
- Paste images: you can quickly paste pictures from the clipboard and insert them as files or Base64
- Embed attachments: you can add attachments to the document and click to open them in the operating system.
- Code running: support to run JavaScript, PHP, nodejs, Python, bash code
- To-do list: support to display the to-do progress in the document. Click to quickly switch the to-do status.
- Quickly Open: you can use shortcut key to open the file switch panel to quickly open files, tagged files, and full-text search for file contents.
- Integrated terminal: support to open the terminal in the editor to quickly switch the current working directory
- Katex: support katex expression
- Style: Markdown uses GitHub styles and features
- Repository: multiple data locations can be defined for document classification
- External link conversion: convert external link or Base64 pictures into local pictures
- HTML resolvingï¼you can use HTML code directly in the document, or use shortcut keys to copy and paste HTML to Markdown
- Multiple formats export: the backend uses pandoc as converter
- TOC: write
[toc]{type:** "ol", level:** [1,2,3]}
to generate TOC where you need to generate a directory - Edit table cell: double-click a table cell to quickly edit
- Copy title link: copy title link path to the clipboard for easy insertion into other files
- Embedded Applets: document supports embedded HTML Applets
- Embed PlantUML graphics: document supports embedded plantUML graphics
- Embed drawio graphics: document supports embedded drawio graphics
- Embed ECharts graphics: document supports embedded Echarts graphics
- Embed Mermaid graphics: document supports embedded Mermaid graphics
- Embed Luckysheet tables: document supports embedded Luckysheet tables
- Mind map: nested list can be displayed in the form of a mind map
- Element attribute writing: any attribute of an element can be customized
- Table enhancement: support table title with multiple lines of text, list and other features
- Document link: support to link other documents in the document and jump to each other
- Footnote: support writing footnotes in the document
- Custom container: support custom containers similar to VuePress default themes
- Macro replacement: support for embedded JavaScript expressions to dynamically replace document content
- Image hosting service: support PicGo image hosting service
- OpenAI: support for OpenAI auto completion
- Custom plug-ins: support writing JavaScript plug-ins to expand editor functionality. The plug-in is placed in the
home directory/plugins
. Refer to plug-in Development Guide
Screenshots
Changelogs
v3.76.1 2024-09-06
Windows | macOS arm64 | macOS x64 | Linux AppImage | Linux deb
- feat: Added support for the Russian language
- feat: Added an entry point for usage guidance
- feat: Optimized the completion of ordered list numbers
- feat: Added
{docHash}
placeholder to the image save directory configuration - fix: Fixed an issue where the input box might not be focusable on Windows
- fix: Fixed the issue of incorrect read-only status in the editor under certain conditions
- fix: Fixed the issue of incorrect size calculation for Mermaid rendering under certain conditions
Supports
Wechat Group
Top Related Projects
📝A simple and elegant markdown editor, available for Linux, macOS and Windows.
Community plugins list, theme list, and releases of Obsidian.
Universal markup converter
The Markdown-based note-taking app that doesn't suck.
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot