~bzg/orgweb

ref: bd536bca9e4abae968c690f749cbcc6514d12c9e orgweb/index.org -rw-r--r-- 9.8 KiB
bd536bcaBastien README: Add a sentence on how to contribute 5 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
#+title: Org mode for Emacs
#+setupfile: setup.org
#+description: Org: an Emacs Mode for Notes, Planning and Authoring
#+html_head: <link rel="stylesheet" href="/resources/style/index.min.css" type="text/css" />
#+html_head: <link rel="preload" href="/resources/img/org-mode-unicorn.svg" as="image" type="image/svg+xml">
#+include: "./resources/preamble.html" export html

#+html_head: <link rel="stylesheet" href="/resources/style/org-demo.min.css" type="text/css" />
#+include: "./resources/normal-outline-3.html" export html

#+begin_export html
<div class="banner hero" itemscope itemtype="https://schema.org/SoftwareApplication">
  <img src="/resources/img/org-mode-unicorn.svg"
       alt="Org unicorn logo" itemprop="image"/>
  <div>
    <h2>
      <span itemprop="name">Org Mode</span>
      <p class="subtitle">Your life in plain text</p>
    </h2>
    <p>
      A <a href="https://www.gnu.org/software/emacs/" style="color: inherit; font-weight: bold; font-style: italic;"
           title="An extensible, customizable, free/libre text editor">GNU Emacs</a>
      major mode for <span itemprop="applicationCategory"> keeping notes, authoring documents, 
      computational notebooks, literate programming, maintaining to-do lists, planning
      projects, and more &mdash; in a fast and effective plain text
      system.</p>
    <p><code>git clone git://git.sv.gnu.org/emacs/org-mode.git</code></p>
    <p class="bubble">
      Support via&ensp;
      <a href="https://liberapay.com/bzg" title="Donations always help"
         style="font-weight: bold; display: inline-block">
        <img class="inline" src="/resources/img/external/librepay.svg" alt="Liberapay logo"/>
        Liberapay</a>&ensp;
      <a href="https://github.com/sponsors/bzg" title="Donations always help"
         style="font-weight: bold; display: inline-block">
        <img class="inline" src="/resources/img/external/github.svg" alt="GitHub logo"/>
        GitHub</a>&ensp;
      <a href="https://www.paypal.com/paypalme/bzg/10" title="Donations always help"
         style="font-weight: bold; display: inline-block">
        <img class="inline" src="/resources/img/external/paypal.svg" alt="Paypal logo"/>
        PayPal</a></p>
    <meta itemprop="operatingSystem" content="Linux, MacOS, Windows">
    <meta itemprop="softwareVersion" content="9.3.8">
    <meta itemprop="datePublished" content="2020-08-07">
    <meta itemprop="url" content="https://orgmode.org">
  </div>
</div>
<div class="banner slim grey faded inline">
  <p style="width:90vw; color:#515151">
    Created by
    <a target="new" href="https://staff.science.uva.nl/~dominik/"
       style="font-weight:500; color:inherit">Carsten Dominik</a>
    in <a target="new" href="/manual/History-and-Acknowledgments.html" style="color:#6e6e6e">2003</a>,
    maintained by <a target="new" href="https://bzg.fr" style="font-weight:500; color:inherit">Bastien Guerry</a>
    and developed by
    <a href="https://orgmode.org/org.html#History-and-Acknowledgments" style="color:#6e6e6e">many others</a>.</p>
</div>
#+end_export

* Highlights
  :PROPERTIES:
  :HTML_CONTAINER_CLASS: columns no-heading
  :END:

** Features
@@html:<a href="features.html">@@
#+attr_html: :alt Three stars :title Delve into the possibilities
[[file:resources/img/stars.svg]]

@@html:</a>@@

** Install
@@html:<a href="https://orgmode.org/org.html#Installation">@@
#+attr_html: :alt Downwards facing arrow :title What are you waiting for?
[[file:resources/img/install.svg]]

@@html:</a>@@

** Quickstart
@@html:<a href="quickstart.html">@@
#+attr_html: :alt Running stickfigure :title Start using Org. You'll never stop.
[[file:resources/img/quickstart.svg]]

@@html:</a>@@

** Contribute
@@html:<a href="worg/org-contribute.html">@@
#+attr_html: :alt Git branch symbol :title Yes. Do this.
[[file:resources/img/contribute.svg]]

@@html:</a>@@

* Elaboration + demo image                                        :ignore:

#+attr_html: :style margin-top:2rem;
Org is a highly flexible structured plain text file format, composed
of a few simple, yet versatile, structures --- constructed to be both
[[https://karl-voit.at/2017/09/23/orgmode-as-markup-only/][simple enough for the novice]] and [[http://howardism.org/Technical/Emacs/literate-devops.html][powerful enough for the expert]].

Get a glimpse of the expressive power Org offers in the example below.
Click the headings and links to discover how Org intelligently folds structural content.

#+include: org-demo.html export html

* Further reading
  :PROPERTIES:
  :CUSTOM_ID: reading
  :END:

Beyond the [[file:quickstart.org][quickstart]] and the [[file:manual/index.html][manual]], Org has a [[file:guide/index.html][guide]] and a wealth of
community-written documentation on [[https://orgmode.org/worg/][Worg]] .

Nearly every Org user has a story to tell about how Org enables and
empowers them --- some have found it so useful that they have written
[[https://orgmode.org/worg/org-papers.html][(scientific) papers]] about the value of Org for conducting [[https://en.wikipedia.org/wiki/Reproducibility#Reproducible_research][reproducible
research]]. Some have produced third party tools to enjoy Org outside of
Emacs, such as mobile applications.

* More Org
  :PROPERTIES:
  :CUSTOM_ID: more
  :END:

The /de facto/ mimetype for Org files is =text/org=. Org files use the
~.org~ extension. Most operating systems don't know to open ~.org~ files
in Emacs, but they can be configured to do so without much effort.

While the reference implementation of Org in Emacs lisp is by far the
most featureful, there are many additional [[file:tools.org][tools]] that work with Org.

#+begin_center
#+attr_html: :class btn
[[file:tools.org][Tools that work with Org]]
#+end_center

* [[https://orgmode.org/worg/][Worg]], a /World/ of Org
  :PROPERTIES:
  :CUSTOM_ID: worg
  :END:

Org and Org-mode have so many use cases that it is simply not possible
to easily document them, let alone show them all off on a single page.
As a result, [[https://orgmode.org/worg/][Worg]] serves as a community wiki and provides a place to
document and share information about all aspects of using and working
with Org.

For example, Worg contains:

- [[https://orgmode.org/worg/org-faq.html][The FAQ]]
- [[https://orgmode.org/worg/org-hacks.html][Org hacks]]
- [[https://orgmode.org/worg/org-tutorials/index.html][A list of tutorials]]
- [[https://orgmode.org/worg/doc.html][Documentation on all hooks, commands and options]]
- [[https://orgmode.org/worg/org-in-the-wild.html][Org in the wild]]
- /...and much more/

Worg is maintained as a Git repository of Org files that are published
as an HTML website.  New [[https://orgmode.org/worg/worg-git.html#contribute-to-worg][contributors are welcome]].

#+BEGIN_SRC shell
~$ git clone https://git.sr.ht/~bzg/worg
#+END_SRC

* Joining the mailing list
  :PROPERTIES:
  :CUSTOM_ID: mailing-list
  :END:

Org mailing list is the central place where to connect with Org
community.  You can [[https://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe to the list]] and browse the list archive 
on [[https://list.orgmode.org][list.orgmode.org]] or on [[https://lists.gnu.org/archive/html/emacs-orgmode/][this mailman page]].

If you are not a subscriber to the list, you can still send an email
to [[mailto:emacs-orgmode@gnu.org][emacs-orgmode@gnu.org]], we will add you to the whitelist of people
who can reach the list.

You can [[https://orgmode.org/worg/org-mailing-list.html][read more on the mailing list]] and more information on [[https://orgmode.org/worg/org-web-social.html][Org news
on the social web]].

You can also connect with other org-thusiasts via IRC at ~#org-mode~ on
[[https://libera.chat/][Libera.Chat]].

The full [[https://orgmode.org/worg/contributors.html][list of contributors]] to Org mode is maintained in /Worg/ and
you can also check the manual's [[https://orgmode.org/org.html#History-and-Acknowledgments][acknowledgments]].

* Doom, Spacemacs, Scimax and popular configs
  :PROPERTIES:
  :CUSTOM_ID: configs
  :END:

The Emacs starter kits [[https://github.com/hlissner/doom-emacs][Doom]], [[https://www.spacemacs.org/][Spacemacs]] and [[https://github.com/jkitchin/scimax][Scimax]] come with a curated
set of packages and configurations that aim to enhance Org mode (and
Emacs more generally) for particular use cases.  They include Org
along with integrations between =org-mode= and other modes (such as
=evil-mode=).  Here are links to the current packages included with
[[https://github.com/hlissner/doom-emacs/blob/develop/modules/lang/org/packages.el][Doom]], and [[https://github.com/syl20bnr/spacemacs/blob/master/layers/%2Bemacs/org/packages.el][Spacemacs]].  /Scimax/ is deeply integrated with Org so a good
place to start is the [[https://github.com/jkitchin/scimax/blob/master/scimax.org#org-mode][manual]].  /Doom/ installs a version of Org that is
close to the development ~HEAD~, while /Spacemacs/ and /Scimax/ track org
elpa.

Starter kits often make significant changes to the default user
experience for Emacs.  If you are looking for something closer to
vanilla Emacs there are popular configs such as [[https://github.com/purcell/emacs.d/blob/master/lisp/init-org.el][Purcell's emacs.d]] that
include org-mode customization and Org-related packages.

* In Other Editors
  :PROPERTIES:
  :CUSTOM_ID: editors
  :END:

While the full set of Org [[file:features.html][features]] is currently exclusive to Emacs,
basic functionality for Org files has been implemented for a variety
of editors.  Here are some extensions for other editors that enable
support for Org files.

- *Vim* : [[https://github.com/kristijanhusak/orgmode.nvim][orgmode.nvim]], [[https://github.com/jceb/vim-orgmode][vim-orgmode]], and [[https://github.com/axvr/org.vim][org.vim]]
- *Atom* : [[https://atom.io/packages/org-mode][org-mode]]
- *VS Code* : [[https://github.com/vscode-org-mode/vscode-org-mode][vscode-org-mode]]
- *Sublime* : [[https://packagecontrol.io/packages/OrgExtended][OrgExtended]]