#+title: Org mode for Emacs #+setupfile: ../setup.org #+language: cn #+description: Org: an Emacs Mode for Notes, Planning and Authoring #+html_head: #+html_head: #+include: "../resources/preamble.html" export html #+html_head: #+include: "../resources/normal-outline-3.html" export html #+begin_export html #+end_export * Highlights :PROPERTIES: :HTML_CONTAINER_CLASS: columns no-heading :END: ** 特色 @@html:@@ #+attr_html: :alt Three stars :title Delve into the possibilities [[file:../resources/img/stars.svg]] @@html:@@ ** 安装 @@html:@@ #+attr_html: :alt Downwards facing arrow :title What are you waiting for? [[file:../resources/img/install.svg]] @@html:@@ ** 快速入门 @@html:@@ #+attr_html: :alt Running stickfigure :title Start using Org. You'll never stop. [[file:../resources/img/quickstart.svg]] @@html:@@ ** 贡献 @@html:@@ #+attr_html: :alt Git branch symbol :title Yes. Do this. [[file:../resources/img/contribute.svg]] @@html:@@ * Elaboration + demo image :ignore: #+attr_html: :style margin-top:2rem; Org 是一个高度灵活的结构化的纯文本格式,由一些简单又灵活的结构组成。即能[[https://karl-voit.at/2017/09/23/orgmode-as-markup-only/][简单易学]],也能变得[[http://howardism.org/Technical/Emacs/literate-devops.html][专业、强大]]。 通过下面的示例,您能一窥 Org 的表现力。点击标题和链接可以了解 Org 是如何智能地折叠结构化的内容。 #+include: ./org-demo.html export html * 相关文档 :PROPERTIES: :CUSTOM_ID: reading :END: 除了[[file:../quickstart.org][快速入门]]和[[file:../manual/index.html][手册]]外,Org 还提供了另一份[[file:../guide/index.html][指南]],以及在 [[https://orgmode.org/worg/][Worg]] 上丰富的社区文档。 几乎每位 Org 用户都有一个故事来讲述 Org 是如何帮助与赋能他们的——有些人发现 Org 非常有用,于是撰写了[[https://orgmode.org/worg/org-papers.html][(科学)论文]],介绍 Org 在开展[[https://en.wikipedia.org/wiki/Reproducibility#Reproducible_research][可重复性研究]]方面的价值;有些人则制作了第三方工具,以便在 Emacs 之外使用 Org,例如移动应用程序。 * 更多 :PROPERTIES: :CUSTOM_ID: more :END: /事实上/ ,Org 文件的 mimetype 是 =text/org= ;Org 文件用 .org 做扩展名。虽然多数操作系统默认都不是用 Emacs 中打开 .org 文件,但也能轻松地改变配置。 虽然 Emacs Lisp 里的 Org 实现是迄今为止功能最丰富的,但还有许多其他[[file:../tools.org][工具]]可以与 Org 配合使用。 #+begin_center #+attr_html: :class btn [[file:../tools.org][适用于 Org 的工具]] #+end_center * [[https://orgmode.org/worg/][Worg]], Org 的广阔世界 :PROPERTIES: :CUSTOM_ID: worg :END: Org 与 Org-mode 使用案例多得无法轻松地将它们记录下来,更不用说要在一个页面上就能展示出它们了。 因此,[[https://orgmode.org/worg/][Worg]] 作为一个社区 Wiki,是一个用于记录及分享有关使用 Org 的各方面信息的地方。 例如,Worg 包括了: - [[https://orgmode.org/worg/org-faq.html][FAQ 文档]] - [[https://orgmode.org/worg/org-hacks.html][Org hacks]] - [[https://orgmode.org/worg/org-tutorials/index.html][各种教程列表]] - [[https://orgmode.org/worg/doc.html][所有的 hook、命令和选项文档]] - [[https://orgmode.org/worg/org-in-the-wild.html][第三方资源]] - /...及其他/ Worg 用 Git 仓库管理 Org 文件,并以 HTML 形式发布,[[https://orgmode.org/worg/worg-about.html#contribute-to-worg][欢迎新的贡献]]。 #+BEGIN_SRC shell ~$ git clone https://git.sr.ht/~bzg/worg #+END_SRC * 加入邮件列表 :PROPERTIES: :CUSTOM_ID: mailing-list :END: Org 的邮件列表是与 Org 社区联系的中心地带,您可以[[https://lists.gnu.org/mailman/listinfo/emacs-orgmode][订阅邮件列表]],以及在 [[https://list.orgmode.org][list.orgmode.org]] 或 [[https://lists.gnu.org/archive/html/emacs-orgmode/][mailman]] 上浏览列表存档。 如果您不是列表的订阅者,您仍然可以发送电子邮件至 [[mailto:emacs-orgmode@gnu.org][emacs-orgmode@gnu.org]],我们会将您添加到可以访问列表的白名单中。 您可以在[[https://orgmode.org/worg/org-mailing-list.html][邮件列表中阅读更多的内容]],以及在[[https://orgmode.org/worg/org-web-social.html][社交网络的 Org 新闻]]上获取更多信息。 您还可以通过 [[https://libera.chat/][Libera.Chat]] 上的 ~#org-mode~ IRC 与其他爱好者取得联系。 Worg 中保留了 Org mode 贡献者的[[https://orgmode.org/worg/contributors.html][完整名单]],您也可以查看手册的[[https://orgmode.org/org.html#History-and-Acknowledgments][致谢]]内容。 * Doom、Spacemacs、Scimax 和主流配置 :PROPERTIES: :CUSTOM_ID: configs :END: Emacs 的入门套件 [[https://github.com/hlissner/doom-emacs][Doom]]、[[https://www.spacemacs.org/][Spacemacs]] 和 [[https://github.com/jkitchin/scimax][Scimax]] 都附带一组精选的软件包和配置, 皆为在特定用例下增强 Org mode(以及更广泛的 Emacs)。它们包括 Org 与 =org-mode= 和其他模式(如 =evil-mode= )之间的集成。这里是 [[https://github.com/hlissner/doom-emacs/blob/develop/modules/lang/org/packages.el][Doom]] 和 [[https://github.com/syl20bnr/spacemacs/blob/master/layers/%2Bemacs/org/packages.el][Spacemacs]] 包的链接。 /Scimax/ 与 Org 深度集成,因此可以从[[https://github.com/jkitchin/scimax/blob/master/scimax.org#org-mode][手册]]开始学习; /Doom/ 安装的是接近开发 ~HEAD~ 版本的 Org;而 /Spacemacs/ 和 /Scimax/ 则跟踪 org elpa。 入门套件通常会对 Emacs 的默认用户体验进行重大修改。如果你正在寻找更接近原版 Emacs 的配置,可以使用 [[https://github.com/purcell/emacs.d/blob/master/lisp/init-org.el][Purcell 的 emacs.d]] ,其中包括 org-mode 自定义和与 Org 相关的软件包。 * 在其他编辑中使用 Org :PROPERTIES: :CUSTOM_ID: editors :END: 虽然全套[[file:../features.html][特性]]的 Org 目前只有 Emacs 才有,但各种编辑器都实现了 Org 的基本功能。下面是一些支持 Org 文件的其他编辑器扩展: - *Vim* : [[https://github.com/kristijanhusak/orgmode.nvim][orgmode.nvim]]、[[https://github.com/jceb/vim-orgmode][vim-orgmode]] 和 [[https://github.com/axvr/org.vim][org.vim]] - *Atom* : [[https://atom.io/packages/org-mode][org-mode]] - *VS Codium* : [[https://github.com/vscode-org-mode/vscode-org-mode][vscode-org-mode]]