Open-source project
suziwen/markdownxiaoshujiang avatar
suziwen/markdownxiaoshujiang

Markdown Xiaoshujiang for local-first notes and selective sync

小书匠是一款本地优先,去中心化,分布式,支持选择性同步的全平台覆盖知识管理笔记软件。

1,738 stars200 forksUnknownLicense varies

At a glance

What is it?
Markdown Xiaoshujiang is a cross-platform note application built around local storage, Markdown editing, multiple storage backends, and user-controlled synchronization. It fits users who value offline ownership and storage flexibility, but its public repository is an issue tracker rather than a documented source release.
Who is it for?
Markdown Xiaoshujiang is suitable for users who want local note storage and can choose a compatible Git, Dropbox, Evernote, or WebDAV destination. It is less suitable for teams that require centrally administered accounts and a clearly documented shared-data model.
Can I use it commercially?
Not without permission. GitHub finds no licence file in the repository, and without a licence all rights are reserved by default: you may read the code but not reuse it. Check the README, or ask the authors, before using it.
Is it still maintained?
Yes. The repository last received commits 49 days ago.
What is it written in?
GitHub does not report a main language for this repository.

Answers come from the project's GitHub data, last synced on October 22, 2026, and from our analysis. They are not legal advice.

Editorial analysis

Why Markdown Xiaoshujiang takes a decentralized storage approach

Markdown Xiaoshujiang addresses personal knowledge management where notes should remain under the user's control across browsers, desktop systems, and mobile devices. Its central design is local-first storage: the README states that data is kept locally and that the application does not depend on a central server. This differs from applications in which the service's hosted account is the primary location of a note.

That choice makes storage location part of the user's configuration. The README lists local files, GitHub, Gitlab, Gitee, Gitea, Dropbox, Evernote, 印象笔记, 有道笔记, 为知笔记, and WebDAV services such as 坚果云, Seafile, ownCloud, and NextCloud. It also describes selective synchronization and custom synchronization. Based on those statements, a user can decide where notes live and which content crosses device boundaries, rather than accepting one fixed destination.

This architecture is most relevant to individual researchers, developers, writers, and knowledge workers who organize a large personal archive. The available sources do not describe a centralized team permission model, shared workspace administration, or an organization-wide account lifecycle. That absence matters. Markdown Xiaoshujiang should not be interpreted as a documented multiuser knowledge-base product merely because it can connect to services that can also hold shared data.

The practical benefit is ownership of the note data through Markdown files and selectable storage. The corresponding trade-off is that users must understand the differences between local files, repository hosts, note services, and WebDAV endpoints. The README names these destinations, but it does not document their individual conflict-resolution rules or synchronization guarantees.

Markdown Xiaoshujiang's editor and document model

The application supports source editing, split source-and-preview editing, and what the README calls a what-you-see-is-what-you-get editing experience. Its layouts can switch among one, two, or three columns. It also includes focused writing modes, automatic local saving, version management, and a focus indicator for locating the cursor in long documents.

Markdown is the base document format, but the supported content extends beyond basic headings and paragraphs. The README lists outlines, task lists, visual table editing, DrawIO drawings, MathJax formulas, and Mermaid diagrams. Code receives dedicated treatment through syntax highlighting, syntax checking, completion, line numbers, folding, and clipboard image pasting. These features target people who write technical documentation, study mathematics, collect diagrams, or maintain a structured personal archive.

Navigation is partly document-oriented and partly workspace-oriented. The README describes outlines, categories, tags, references, backlinks, calendars, pinned items, secondary filtering, and versions. It also provides browser-like tabs and tab groups for switching among frequently used notes. This is useful when the problem is not only writing Markdown but also finding and revisiting related material.

Editing can be adapted through Vim or Emacs key support and custom shortcuts. The editor includes multi-cursor operation, regular-expression search and replacement within a page, bracket and tag matching, script snippets, and locked-line editing. Those are concrete workflow features, not merely visual themes. Even so, the README does not document collaboration conflict handling, multiuser editing, or permission boundaries, so collaborative use remains poorly specified.

Opening Markdown Xiaoshujiang on the web for a first note

The README provides a web edition and says that it runs in modern browsers including Chrome, Firefox, and Edge without installation. It does not provide repository installation commands, package names, configuration files, or build instructions. The public repository also says that it is only for issues on the Xiaoshujiang website, so cloning this repository should not be presented as a supported installation method.

For a first documented path, open the Xiaoshujiang web edition at the address linked from the README:

text
https://markdown.xiaoshujiang.com

This block shows the documented web address, not a shell command. The README says the web edition provides progressive operational guidance, beginning with basic text input. It does not document the exact menu sequence for creating or storing a first note, so an article should not invent button names or claim that a particular screen will appear.

A sensible first use, limited to documented capabilities, is to enter text in the editor and choose whether to work in source, split, or what-you-see-is-what-you-get mode. A Markdown user can then use outlines, visual table editing, tasks, diagrams, or formulas where relevant. Before relying on synchronization, the user should decide among local file storage and the listed external backends. The sources do not specify the initial import procedure or the precise effect of each storage choice.

The README states that saving to local storage happens automatically. It does not say that every web interaction is offline-capable, nor does it document browser storage quotas. Users who require strict offline use should confirm the current web edition behavior in the product itself.

Storage choices and selective synchronization in Markdown Xiaoshujiang

Markdown Xiaoshujiang separates the note format from the storage destination. Markdown provides a portable document representation, while Git hosting, Dropbox, local directories, note services, and WebDAV provide different ways to retain or transfer files. The README also lists import and export formats including Markdown, zip, HTML, PDF, and Word, plus batch operations.

GitHub, Gitlab, Gitee, and Gitea are listed as storage choices, which may appeal to users who already understand repositories and version control. Local file storage offers the most direct location in the stated architecture. Dropbox and WebDAV cover synchronization-oriented destinations. Evernote, 印象笔记, 有道笔记, and 为知笔记 indicate that the application can connect to established note systems rather than confine users to one vault format.

The term "selective synchronization" is important, but its granularity is not explained in the README. The sources do not state whether selection occurs at document, directory, notebook, tag, attachment, or another level. They also do not explain how simultaneous edits are merged, how deleted files are propagated, or whether repository conflicts are exposed to the user. Those omissions prevent a dependable prediction of cross-device behavior.

Automatic version management is listed as an editing feature. However, the README does not state whether it creates local revisions, Git commits, exported history, or versions in the selected storage service. Users who need an auditable history should inspect that behavior before migrating an important archive.

Desktop, mobile, Docker, and server-side search boundaries

The README describes coverage across web, Windows, Linux, macOS, Android, and iOS. Android and iOS availability is attributed to 有影笔记 rather than being presented as part of the same public repository. A protocol-wakeup feature can invoke Xiaoshujiang from other software on supported desktop systems.

Docker deployment is associated with "天马版" and "天马飞天版". The latter can provide server-side full-text search, while client-side local full-text search is available without relying on that server edition. The sources do not include a Dockerfile, image name, exposed port, environment variable, initialization command, or deployment configuration. Consequently, this article cannot provide a reproducible Docker tutorial.

This repository should not be treated as the application source tree. Its top-level contents consist mainly of `README.md`, images, and `xsj.svg`, while the README separately points to `https://github.com/suziwen/roadbike` as the source address for the Xiaoshujiang website. The public repository's stated purpose is issue handling. That distinction affects adoption, auditing, and upgrades: users cannot derive a supported build from the entries shown here.

The repository is not archived, and its last push was on 2026-09-04. The release list also includes `v8.16.0` on 2026-09-04, following `v8.14.0` from 2025-02-03 and `v8.13.2` from 2024-04-08. These dates indicate recent project activity, but the sources do not provide a release policy, migration procedure, changelog detail, or compatibility matrix for upgrading.

Maintenance, licensing, and migration limits in suziwen/markdownxiaoshujiang

The available license information for `suziwen/markdownxiaoshujiang` is unknown. Neither the repository description nor the README supplies a license identifier or licensing terms. That matters for anyone considering redistribution of code, modification, or relicensing. This is a factual boundary, not a claim about permitted use.

The project is not archived, and its last push was on 2026-09-04. Release `v8.16.0` carries the same date. However, this repository does not expose the implementation source, so its update cost cannot be estimated from files such as build configuration, dependency manifests, or migration scripts. The README points elsewhere for website source code, while the stated purpose of this repository is issues.

Export into Markdown, zip, HTML, PDF, and Word reduces dependence on one application interface for some migration paths. It does not establish that every export preserves links, task state, diagrams, formulas, tags, attachments, versions, or storage metadata. The README names the formats but does not define fidelity or round-trip behavior.

A real limitation is therefore the gap between the feature list and operational documentation. Users cannot determine from the README whether the Docker images are upgradeable, how schema changes are handled, which note services are fully compatible, or what happens when two devices edit the same note offline. For production archives, those questions outweigh interface preferences.

A decentralized alternative to a hosted note workspace

A conventional hosted note workspace usually keeps the user's documents inside a service-controlled account and offers synchronization through that same service. Markdown Xiaoshujiang takes a different path: local storage is the starting point, and the user can select among local files, Git hosts, Dropbox, note services, and WebDAV.

A local Markdown editor is another useful comparison point, although it is not a branded competitor. Such an editor can provide direct file ownership and broad format portability, but it generally does not provide Markdown Xiaoshujiang's documented collection of tabs, backlinks, calendars, visual tables, diagrams, version management, and selectable storage integrations. Markdown Xiaoshujiang, in turn, requires the user to evaluate more destinations and synchronization behavior than a plain local editor.

The project is therefore a better fit than a hosted workspace when local-first storage, Markdown, and destination choice are primary requirements. It is a worse fit when one administrator must enforce account provisioning, sharing policy, and centralized backups. It is also unsuitable as an immediate open-source adoption candidate for engineers who expect this repository to contain the application source, dependency declarations, build instructions, and a license.

Editorial conclusion

Markdown Xiaoshujiang is suitable for users who want local note storage and can choose a compatible Git, Dropbox, Evernote, or WebDAV destination. It is less suitable for teams that require centrally administered accounts and a clearly documented shared-data model. Before adoption, verify availability for the intended platforms, the behavior of the selected synchronization backend, export coverage, and the terms under which the application is licensed.

Frequently asked questions

Does Markdown Xiaoshujiang support local-first notes without a central server?

Yes. The README says local storage is the starting point, notes are kept locally, and the application does not depend on a central server. It also supports user-configured storage and synchronization destinations.

Can I install Markdown Xiaoshujiang from the suziwen/markdownxiaoshujiang repository?

The repository does not provide installation instructions and says it is only for issues. Its listed files are documentation and images, while the README points to another repository for Xiaoshujiang website source code.

Which file formats can Markdown Xiaoshujiang export?

The README lists Markdown, zip, HTML, PDF, and Word. It does not document how faithfully specialized content such as backlinks, diagrams, formulas, tasks, or attachments is preserved in each format.

Does Markdown Xiaoshujiang offer server-side full-text search?

The README says server-side full-text search is available in the Docker-deployed 天马飞天版 edition. It does not provide a deployment image or configuration, so a reproducible Docker setup is not documented here.

Official sources

  1. Issues
  2. Project website
  3. README
  4. Releases
  5. suziwen/markdownxiaoshujiang on GitHub
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/suziwen-markdownxiaoshujiang.svg)](https://hysenlabs.com/projects/suziwen-markdownxiaoshujiang)

Was this useful?