项目已被 Emanote 取代,新项目建议直接用 Emanote;安装步骤需另见官方 install 页面,README 未直接给出命令;想用 GitHub Pages 发布可从 neuron-template 起步
neuron
sridAGPL-3.0活跃维护基于 Zettelkasten 卡片笔记法的笔记与发布工具,能把笔记直接生成静态博客站点,适合长期积累和公开分享知识。
Future-proof note-taking and publishing based on Zettelkasten (superseded by Emanote: https://github.com/srid/emanote)
README 未给出具体安装命令,仅指向 https://neuron.zettel.page/installREADME 未说明
基于 Zettelkasten 的纯文本笔记管理与静态网站发布工具,已被 Emanote 取代
基于 Zettelkasten 卡片笔记法的笔记与发布工具,能把笔记直接生成静态博客站点,适合长期积累和公开分享知识。
核心能力
- 直接管理一个 Markdown 文件目录
- 提供强大的链接语法与层级标签
- 自动生成静态网站用于发布
- 可选集成 Emacs、Vim、VSCode 等编辑器
容易踩的坑
- 1.9.35.0最新正式版2021-08-11 · 2021-08-11 20:32 UTC
Development snapshot of neuron on 2021-08-11 along with a self-contained executable for Linux (details).
- 1.0.1.02020-10-09 · 2020-10-09 17:31 UTC
查看更新说明
- Fix broken
neuron searchin static binary (#429)
- Fix broken
- 1.0.0.02020-10-08 · 2020-10-08 20:14 UTC
查看更新说明
Blog post: https://www.srid.ca/neuron-v1.html
- Updates
- Bump commonmark, commonmark-extensions (0.2)
- Skylighting 0.9 (pure Haskell syntax highlighting)
- Web Interface
- Styling fixes
- Fix incorrect body font (esp. on Windows)
- Fix task list checkbox styling (#233)
- Use superscript for folgezettel link suffix (#346)
- Fix missing clusters in z-index on some cyclic graphs (#357)
- Update Fomantic UI to 2.8.7
- Allow custom HTML snippet in
<head>(#385) - Group orphan zettels in z-index (#380)
- Fix footnote alignment on Firefox (#398)
- Hide footnote refs from search result preview (#326)
- Backlinks improvements
- Backlinks panel now displays all kinds of backlinks (includig uplinks) for sake of completion.
- Styling fixes
- Zettel format
- Wiki-style links: instead of
<foo>you can now use[[[foo]]]; and instead of<foo?cf>, you can use[[foo]]. (#351) - Support regular markdown links (#366)
- Allow title as Zettel IDs (#399)
- Drop support for legacy links (#366)
- Allow specifying time in the
datemetadata propery (#343) - Add
unlistedmetadata property to hide a zettel from z-index (#318) - Markdown:
- Inline tags (#189)
- support for fancy lists (#335)
- Fix hard line breaks to actually work (#354)
- Allow dot in Zettel ID (#369)
- Drop support for legacy date IDs (#368)
- Add
bracked_spansextension (#406)
- Wiki-style links: instead of
- CLI
- Faster querying: add
--cachedoption toneuron query, to run faster using the cache. To keep the cache up to date, make sure thatneuron ribis running. - Add
--idand--searchoptions toopencommand to open given zettel ID or search page respectively (#317) - Use current directory as the default value for
-d(a la. git) (#389) - Adapt
neuron newfor title IDs (#408) neuron search: fail if org is enabled, unless --full-text is used. (#420)
- Faster querying: add
- Static binaries
- Unicode-aware in filenames and links (#424)
- Updates
- 0.6.0.02020-07-24 · 2020-07-24 00:27 UTC
查看更新说明
- Markdown: switch to Pandoc, and commonmark (with extensions). #166
- Markdown parsing is consequently less strict and more permissive
- With this change, neuron can potentially support other text formats (experimental org support already in)
- Raw HTML support (#191)
- YAML block is now optional; title is also optional, while native Markdown H1 titles are now supported (#230)
- Web Interface
- Introduce new "uplink tree" view, replacing connections pane (#195)
- Allow customizing favicon
- z-index: Allow cycles (#248)
- z-index: display parse and query errors (#220, #221)
- CLI:
- Resilient error handling (#202, #215)
- Added
neuron query --graphto get the entire graph as JSON export- Add backlinks query (#216)
- Add bash/zsh shell completion (#239)
- neuron new: title is optional (#232)
- Bug fixes
- Fix 'neuron new' generating invalid Markdown when title contains special characters (#163)
- Allow custom CLI in $EDITOR (#227)
- Others
- Reduce install size (#240)
- Nightly docker releases
- Automatic publishing through neuron-template
- Markdown: switch to Pandoc, and commonmark (with extensions). #166
- 0.4.0.02020-05-09 · 2020-05-09 16:02 UTC
查看更新说明
- Notable changes
- More convenient links;
<foobar>instead of[foobar](z:/)(#59) - Hierarchical tags, with tag pattern in zquery (#115)
- Change default ID generation to use random hash (#151)
- Add
datefield to Markdown metadata
- Add
- Added
neuron queryto query the Zettelkasten and get JSON output (#42)
- More convenient links;
- CLI argument parsing revamp
- Zettelkasten directory is now provided via the
-dargument.- Its default,
~/zettelkasten, is used when not specified. - This directory must exist, otherwise neuron will error out.
- Its default,
- The output directory is now moved to
.neuron/output neuron ... rib serveis nowneuron rib -wS.
- Zettelkasten directory is now provided via the
- CLI changes:
- Full text search:
neuron search --full-text - #43: Add
neuron search -eto open the matching zettel in $EDITOR - Allow customizing output directory
- Added
neuron opento open the locally generated Zettelkasten site. - #107: Add full path to the zettel in
neuron queryJSON
- Full text search:
- Web interface:
- Custom themes for web interface
- Display all backlinks to a zettel (even those not in category tree) (#34)
- Simplified link style (#151)
- Client-side web search (#90)
- Add JSON-LD breadcrumbs (#147)
- Add query to display tag tree (#121)
- Custom alias redirects
- Tags are restyled and positioned below
- Produce compact CSS in HTML head
- #24: zquery is displayed in HTML view.
- #100: Tables are styled nicely using Semantic UI
- Bug fixes
- Fix regression in neuron library use
- #130: Handle links inside blockquotes
- Notable changes
用户点评
登录用户的真实使用记录,可按版本和硬件筛选还没有人点评。第一个说出真实体验的人最有价值。
neuron
neuron is a future-proof app for managing your plain-text notes in Zettelkasten style, as well as for publishing them on the web. Read its philosophy.
Highlights
- Work with a directory of markdown files
- Powerful linking syntax and hierarchical tagging
- Auto-generated static web site (see examples)
- Simple to use, with optional editor integration (emacs, vim, vscode, etc.)
Getting started
See https://neuron.zettel.page/install to install and use neuron locally. Or start from neuron-template if you just want to publish a neuron site using GitHub Pages.
Developing
Development documentation, including instructions to install from source, is available in CONTRIBUTING.md.
Discussions
To discuss and propose ideas, visit the Discussions tab on GitHub. To chat about the project join Matrix.