15 ms·
Org-Mode Is One of the Most Reasonable Markup Languages to Use for Text
- Crontab 9y agoInteresting article. I have to admit to never thinking of Org-mode as a markup language unto itself.
- mikekchar 9y agoI used Org mode a long time ago (maybe a decade) and then I switched to vim (for boring reasons) and kind of lost track of Org mode. In the meantime I started using markdown and especially github flavoured markdown for writing. Eventually, I was looking for a TODO app and realised the Org mode gave me everything I was looking for -- and Emacs was a dramatically better UI than any other TODO app that I looked at. This got me back to Emacs (now enhanced with Evil mode which works remarkably well). The interesting thing is that I've completely switched back to Org mode for notes. I don't even use any of the org mode features in Emacs when I'm writing. As the author of the article says, I just find it a more convenient text markup language. Sometimes I'll update org mode documents in Vim and I don't even really realise that I'm doing it because all I really want is structured documentation with folding. However, I think for org mode to become mainstream you have to get another editor with some feature parity to Emacs. Tables are a killer feature of Org mode in Emacs. Another thing that I think is needed is better renderers outside of Emacs. Github has an orgmode renderer and it is not very good at all. I have a colleague that does all his project planning in Org mode (highly recommend, by the way) and he converts his documents to github flavoured markdown before pushing them -- which is crazy. I'd love to see this format gain some more traction...
- vvanders 9y agoYeah, as a heavy vim users who wanted org mode Spacemacs in Evil mode was all that I needed. One thing I love with org mode is how dynamic the document is. Inserting [/] or [%] to get updated task count/percentage as TODO underneath the header is fantastic.
- blunte 9y agoI'm sold. Is it a (near or full) replacement for markdown?
- mikekchar 9y agoI can't think of a single thing it can't do that markdown can do, but I can think of several things it does that markdown doesn't do. Main problem (as I note in another message) is lack of feature parity in non-Emacs implementations and lack of quality html renderers outside of Emacs.
- petepete 9y ago> I can't think of a single thing it can't do that markdown can do Be human-readable, for starters.
- peatmoss 9y agoThat's subjective. I know org-mode and prefer it. The people espousing the intrinsic comparative readability of Markdown all appear to be deeply steeped in that world. For me the org-mode syntax is more logical than Markdown—and I can have cross references.
- petepete 9y agoYou know org mode and prefer it, fair enough. To someone unfamiliar with both syntaxes, Markdown is much easier to grasp; because it's simpler it's just more readable.
- peatmoss 9y agoIs that true because you're privy to the results of that experiment? Or is it true because you're most comfortable with Markdown and are starting from the unshakable belief that Markdown is intrinsically easier?
- kaushalmodi 9y ago
- swsieber 9y agoI'm mostly sold. The only downside is that the preformatted text blocks have each line start with a ':'. That makes it terrible for naive copy/paste from the source document... But other than that, it really does look great.
- lottin 9y agoIn Emacs, <s + <TAB> at the beginning of a line starts a source block. The delimiters are quite distracting though. This is an issue I have with markup languages in general, either you use markup very sparingly or the document easily becomes unreadable.
- peatmoss 9y agoAnd you can customize it too! In the past I have set up <r to create an R source block with some common code block parameters for R.
- Nullabillity 9y agoYou can also format source code like this: #+BEGIN_SRC bash $ echo Hello, World! #+END_SRC That will also give you syntax highlighting, and allow you to edit it as a bash script (in Emacs, at least). I don't remember it off the top of my head, but there's also a similar syntax to include a file directly, instead of duplicating it in the org file.
- giggles_giggles 9y ago#+INCLUDE
- deleted 9y ago[deleted]
- trengrj 9y agoI love the concept of using lightweight markup text but a lot of the comments in the article also apply to Markdown. Personally I've switched to using Markdown for everything possible and have started using Typora as my rich text editor as it provides the first fluid WYSIWYG markdown interface I have seen with easy export to PDF / word / HTML.
- ruricolist 9y agoRegarding the syntax for URLs: I for one think Markdown is better here. I have seven megabytes of notes in Org mode and I still regularly mess up the order of the URL and the text.
- saulrh 9y agoHeh, exactly the opposite here - In Markdown I can never remember which one one gets square brackets and which one gets parens.
- pmoriarty 9y agoYou shouldn't need to manually deal with links anyway. In Emacs you should be able to use C-c C-l (org-insert-link) to get a prompt for the link and the description which will then be converted to org-format for you.
- ruricolist 9y agoI'm pretty sure I knew about that at one point, but then forgot -- possibly more than once. Perhaps a public shaming will help me remember this time.
- juki 9y ago`C-c C-l` is also useful if you're linking to files (org or other). You can use `M-x org-store-link` in the link destination, and a subsequent `C-c C-l` will let you add that link easily.
- ktpsns 9y agoI find much of the criticism against ("the") Markdown opinion-based. For instance, I hardly can remember whether it is `[http://example.com](foo)` http://example.com](foo)` or `(http://example.com)[foo]` http://example.com)[foo]` in Markdown but I would also confuse `[[http://example.com][foo]]` http://example.com][foo]]` with `[foo][http://example.com]]` http://example.com]]`. In the same spirit, one may like or hate `*` for indicating headings (the choice is really unnatural for me, always thinking of a list).
- __john 9y agoThe way I remember [] before () is that [] is "basic" and square and () is "refined" and curvy. Seems silly but it helps me.
- lancefisher 9y agoI remember “brackets come before parentheses” alphabetically ;)
- 52-6F-62 9y agoThese are both helpful mnemonic tricks. I always forget links' syntax. More generally in this post I find Markdown has a pretty short learning curve, is highly readable and logical (EG. I like the number of `#` for level of headings). My biggest issue with Markdown is the different interpretations and how they're represented. Eg. Github vs. someplace else vs. Markdown-viewer apps. Org in comparison looks more concise, but less readable, IMO.
- Terretta 9y ago"squared circle" = []() https://en.wikipedia.org/wiki/Squaring_the_circle https://en.wikipedia.org/wiki/Squaring_the_circle
- accordionclown 9y agoi can't remember who i heard it from first, but "squaring the circle" is the phrase that (finally!) helped me remember the order after years of having to look it up every single time i needed it. i still have to look up the format for images every time.
- pjkundert 9y agoOrg-mode is awesome. - supported in GitHub: README.org - ipython integration allows full code execution to generate inline plots by executing the code in the document. - many other features too numerous to mention; it’s the truly ancient granddaddy of markup, developed over decades.
- justinhj 9y agoSurprisingly org-mode is nowhere near as old as emacs. It was "born" in 2003
- danieldk 9y ago- ipython integration allows full code execution to generate inline plots by executing the code in the document. Of course, this is not restricted to iPython/Jupyter. Babel allows you to execute code in many languages inline, without running a full Jupyter instance/kernel: http://orgmode.org/worg/org-contrib/babel/ http://orgmode.org/worg/org-contrib/babel/ You can also generate inline plots with Babel. Let the code snippet generate an image, return the file name from the block, and set the result type to file.
- bch 9y agoWhat's the state of the art with library implementations of org-mode? I feel like I looked into this years ago, but I don't have my notes in front of me. The only way I've used org-mode is the canonical Emacs implementation, which (at the time) was reason enough for some people to take up learning Emacs.
- jhoechtl 9y agoFor Golang there is https://github.com/chaseadamsio/goorgeous https://github.com/chaseadamsio/goorgeous which is also used by the static website generator Hugo to natively support .org-mode
- bch 9y agoWas thinking of C, actually. I should have specified. This could be the project for me to link C and Go, though...: C -> Go -> goorgeous
- hn_throwaway_99 9y agoI like Org-mode, but I thought the criticism against Markdown for having so many different versions was short-sighted. I'm very much reminded of this famous XKCD: https://xkcd.com/927/ https://xkcd.com/927/ The reason Markdown has so many versions is because it's been so successful and is used by so many different tools and in many different contexts. I guarantee if Org-mode became a "standard" markup language outside of Emacs that it, too, would sprout different versions.
- jerf 9y agoThe reason why Markdown has so many versions is that its original author was aggressively against the idea of trying to produce a spec for it, so several re-implementations went on to become their own thing. While dialects probably would have sprouted they probably all would have supported the same core, at least, and there quite likely would be fewer of them.
- throwanem 9y agoGruber also stopped development on markdown.pl a long time ago. I suspect the worthwhile innovations made by Org reimplementers would very quickly become part of org-mode as well.
- unsignedint 9y agoI tried to like Org-mode, but one major complaint I have with Org-Mode syntax is its inability to effectively handle text in a language without spaces; some format syntax and link can't be segmented in languages like Japanese. I guess this is also said to be true for other format like markdown, but at least format like HTML doesn't have that problem...
- c-smile 9y agoAnd yet RTL languages ...
- jacalata 9y agoWhat about them? Does org mode handle them better/worse than other formats?
- throwanem 9y agoCould you provide an example document that exhibits the issue, and a more detailed description of what goes wrong? Say, to one of the email addresses in my profile. Thanks in advance!
- unsignedint 9y agoPretty simple things; テスト*テスト*テスト テスト_テスト_テスト テスト[[http://orgmode.org/][テスト]]テスト Back when I actually have been using org-mode extensively (loved ID based document linking, Calendar file export, etc.) just I couldn't use it for anything that involves Japanese text which was 1/3 of things I had to deal with. I've actually tried suggesting on a developer's list for possibility of "negative" space where it can denote "space, but not quite space" which wasn't received well..
- throwanem 9y agoYeah, that's a somewhat tricky problem, I think - the regexes depend on surrounding whitespace and are pretty hairy in general, as I recall. Something might be done with surrounding word boundaries instead, but I'm not sure how Emacs regexes handle those, and also unsure how the semantic applies in Japanese text - as I'm very unfamiliar with the language, I haven't yet found a chance to experiment. As I find the time, I'll see what I can do with these examples - thanks for providing them!
- c-smile 9y agoMarkdown/org-mode is a poor man WYSIWYG I would say. You can easily say "this line is kind of header" but it is not human readable as it all happens inside source code editor having monospaced fonts like in this very widget I am typing the message on HN site. Plain text blocks is plain pain in markdowns. Web platform has no concept of tabs - counting whitespaces for each line... And tables ... like 20 years ago we were doing with pseudo-graphic symbols - formatting nightmare. That's why I've introduced "magic sequences" : https://notes.sciter.com/2017/09/09/magic-sequences-a-la-markdown/ https://notes.sciter.com/2017/09/09/magic-sequences-a-la-mar... - the best of two worlds - WYSIWYG but with Markdown typing twist.
- iheartmemcache 9y agoWYSIWYG is kind of limiting though. I.e., I can use mermaid[1] way faster than I can use Visio. I can type out a mathematics expression way faster in TeX than I can using Word and their (greatly improved, I'll give them that) Equation Editor. Hell, I'm barely 'proficient' at the AutoDesk toolset, but I can usually out-model assemblies using their LISP interface over someone with a SpaceMouse Pro[2]. Generally though, you don't need the table or graph to be "readable" if you're the one constructing the content for others to consume, since you've already modeled the structure of the content within your head. Those -item1, -item2, --subitem1 demarcations are already internalized in your head. (Though, if we're talking about a platform for capturing data/mind-mapping/outlining/note-taking, this may not be entirely true, I admit.) Even Adobe opts for a non-WYSIWYG DITA/SGML for their professional content management systems if only because publishing a book or magazine becomes a editorial nightmare. (In publishing, they have separations of controls just like we have separations of concerns. Our graphics and front-end guys have control over the .css and what-have-you, while our data guys will have control of the schema, and our app guys will have control of the binary; likewise, they'll have someone in charge of typesetting, someone who performs the layout management so the interstitial ads look consistent within your magazines theme or whatever, someone generating the content, and then an editor who finally signs off on it.[3]) Now that I think about it, a magazine has many source-control-management problems quite similar to what we have. Magic sequences are pretty brilliant, I'll give you that. If it 'degrades gracefully' (i.e., when copied into a standard instance of notepad.exe or Nano, it's still grokable), that hybrid solution might be the closest panacea we have. Keep on working on that project, it has tons of interesting, orthogonal avenues to explore[4] ===== [1] https://github.com/knsv/mermaid https://github.com/knsv/mermaid [2] https://www.amazon.com/3DX-700040-3Dconnexion-SpaceMouse-Pro-3D-Mouse/dp/B006GPZ17K/ https://www.amazon.com/3DX-700040-3Dconnexion-SpaceMouse-Pro... Pretty much the paragon of HIDs for CAD, in my limited use. For the last 10% of touchups it's second to none, but at the project level it's still slower than using the LISP derivative once you build up a sufficient set of macros. [3] https://en.wikipedia.org/wiki/Desktop_publishing https://en.wikipedia.org/wiki/Desktop_publishing ArborText and Framemaker Server are the two industry standards at least in my experience. [4] I.e., take say, chemists who want to share their findings with people in their dept. Being able to design their own markup for Lewis diagrams, multiple representations of orbitals, degenerates states, etc -- then have them real time render the observed values -> a generated chart rendered in a consistent theme (a la Jupyter Notebook, but..better...) I'd imagine would be quite powerful.
- theodorewiles 9y agoshameless plug: https://github.com/theodorewiles/org-mind-map https://github.com/theodorewiles/org-mind-map
- hacoo 9y agocool! I'll have to try this out :)
- paultopia 9y agomight be a good argument, but too late? It feels like Markdown has won—look at editor preview availability, prevalence of being built into webapps, etc. For example, almost everything I write now text-wise I do in Byword, which gives me seamless sync on iOS/mac and has markdown as a first class citizen; longer writing usually gets passed through scrivener first, which has markdown as a first-class citizen, if I post a question on SO...
- ams6110 9y agoMarkdown doesn't do tables. That's the killer for me. Yes I know I can use HTML but too much of that and I quickly get to the point of preferring HTML for the whole document. Easier to stick with just one markup format.
- hellabites 9y agoGithub flavored markdown does do tables (in a manner that's almost equivalent to org): https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables https://github.com/adam-p/markdown-here/wiki/Markdown-Cheats...
- c-smile 9y agoHow ugly it is, sigh.
- danieldk 9y agoin a manner that's almost equivalent to org Not really, in org-mode, you can compute columns using expressions (like in a spreadsheet) [1]. Moreover, you can feed a table to an (executable) source code block and/or you can store the output of a source code block to a table. Just to give an example why this could be useful: suppose that you have a code snippet that produces some statistics. You can execute this snippet directly in the org-mode document and have the result in an org table. Then, you could execute another code snippet (e.g. using R) that uses the table as the input and produces a graph that is embedded inline in your org document. In GUI Emacs, you can even preview the resulting graph. My primary criticism is that the value of org-mode documents decreases enormously outside Emacs. [1] http://orgmode.org/worg/org-tutorials/org-spreadsheet-intro.html http://orgmode.org/worg/org-tutorials/org-spreadsheet-intro....
- kaushalmodi 9y agoShameless plug: https://ox-hugo.netlify.com https://ox-hugo.netlify.com I just announced the ox-hugo package. I love the blogging framework of Hugo, but disliked that I needed to manually take care of the post front matter and also noticed the shortcomings of writing in just Markdown. I also missed the tree-based text organization of Org mode. So this package was born. Writing posts in Org mode gives you all the Org markup power (that's already more than Markdown), plus a lot more! like Org Babel, property inheritance, etc. An example: I wrote this post ( https://scripter.co/notes/string-functions-nim-vs-python/ https://scripter.co/notes/string-functions-nim-vs-python/ ) that's heavy with code blocks and results of evaluating those code blocks. It would be super-painful in Markdown to paste all the code blocks and also their results. In the Org source: https://gitlab.com/kaushalmodi/kaushalmodi.gitlab.io/raw/master/content-org/notes/string-fns-nim-vs-python.org https://gitlab.com/kaushalmodi/kaushalmodi.gitlab.io/raw/mas..., each of the #+RESULTS blocks in that Org source are auto generated using the Org Babel feature. I elaborate more on why I use ox-hugo, or why I use Org for blogging in native Emacs environment here: https://ox-hugo.netlify.com/doc/why-ox-hugo/ https://ox-hugo.netlify.com/doc/why-ox-hugo/ Even if one is not using Emacs as their editor, as the OP mentions, the Org markup is simple enough that anyone can use their favorite editor to write in Org. To add to that, using a little Makefile, they can run Emacs in batch mode to take advantage of true Org mode features like Org Babel, etc. For instance, one can clone the ox-hugo repo, https://github.com/kaushalmodi/ox-hugo/ https://github.com/kaushalmodi/ox-hugo/, and just run "make test" or "make doc" to let ox-hugo do its thing, without having anyone to know what to do after opening Emacs, what command to run, etc. "make doc" will generate all the Markdown content needed for the entire documentation website that I linked in the very beginning of this comment, all from a single Org file.. You cannot do that in Markdown.
- bastijn 9y agoCall it blasphemy but in my opinion the markdown is easier to read than the orgmode in your examples. Especially when you think away your syntax highlighting. Markdown is not just for short notation over html, it is also for readability of plain text. I'd argue it's better suited at that, especially to the untrained, than orgmode. I use markdown in my organization because even non-technical people can write and read it easily and without top much eyestrain (and we convert it to websites and pdf for official release). I also disagree with the original post to the extent that it is correct but attacks issues that are not there in practice. Yes, there are multiple versions but this is not a major issue. Most people use github flavored anyway. There is an initiative to standardize markdown by the way [0]. The fact that it is not really taken up tells me there is no big issue with having multiple markdown flavors. [0] http://commonmark.org/ http://commonmark.org/
- ams6110 9y agoI honestly don't find any of these markup languages significantly easier to use than just writing HTML.
- grondilu 9y agoI think the point of markup languages is not so much about convenience for writing (assuming that's what you're talking about) rather than readability in pure text form. HTML is readable in pure text but it does not look that great.
- ams6110 9y agoYou're right, but as soon as you introduce anything more than you could have done on a typewriter, most of these formats stop looking great pretty quickly also.
- aidenn0 9y agoasciidoc is easily 10x easier than writing HTML. Org mode is pretty good too, but I haven't used it for very complex things, so can't make a full comparision. Markdown and restructured text are both easier than HTML for common things, but markdown falls on its face for complicated things and rST ends up devolving into a bunch of directives that are just marginally better than HTML.
- rsync 9y agoAre there any non-personal wikis (a wiki with user login and web-based editing) that use org-mode ?
- gglitch 9y agoI don't think this is exactly what you're asking, but both GitLab and GitHub render Org-mode correctly, including links. That makes for a pretty easy file-based wiki.
- WalterBright 9y agoLooks pretty nice. One nit: : Simple pre-formatted text such as for source code. : This also respects the line breaks. *bold* is not bold here. This makes it annoying to cut/paste code in and out of the markup text. It's better to use a block syntax for that, like: ``` Simple pre-formatted text such as for source code. This also respects the line breaks. *bold* is not bold here. ```
- bitwize 9y ago> This makes it annoying to cut/paste code in and out of the markup text. Well, not that annoying because you're inside Emacs and operating on rectangles of text is a doddle. But the preferred syntax is to enclose the source code in #+BEGIN_SRC/#+END_SRC blocks anyway. Using this method also enables neat features, such as activating the appropriate major mode for each block of text and doing literate programming.
- koffiezet 9y ago> because you're inside Emacs No, I won't be. The article also stated: > Please do note that this is not about Emacs. This is about Org-mode syntax and its advantages even when used outside of Emacs. Sorry, but a "reasonable" markup language in my book would be one I would be comfortably using anywhere, meaning typing in manually (which I do a lot with markdown). #+BEGIN_SRC/#+END_SRC is too verbose and ':' as a line prefix impractical. This won't see any wide-spread adoption outside of the Emacs world, markdown's adoption is widespread and is here to stay I'm afraid, even though it has tons of pitfalls and different styles. For pretty much everything, it's "good enough", and some things make a lot more sense if you're actually typing the text.
- bitwize 9y agoMarkdown does no better on this particular front; each line of preformatted text must be prefixed with four spaces which is EXCEEDINGLY impractical.
- 9y ago
- aldoushuxley001 9y agoAny idea on how I might go about implementing this in Django?
- geokon 9y agoI love orgmode, but what's the advantage over asciidoc? asciidoc looks cleaner to me the other small disadvantage is that text isn't really bound to headers. So headers and text just kinda float around meaninglessly. So you can't have: * Header topic1 introductory text * * Subheader some descriptive text related to the subheader more text to wrap up topic1
- GordonS 9y agoI'm a big fan of asciidoc - I started using it for all my technical documentation a few years ago and haven't looked back. It gets the balance between simplicity and features just right.
- Moyamo 9y ago> what's the advantage over asciidoc? Exactly what is states in the article. Asciidoc has 3 different types of headings (prefix, pre-postfix and underlined). http://example.com[Text] The form is simple but for complex URLs, the [Text] might look like being part of the URL itself. Not beautiful but at least something I could live with. Additionally asciidoc uses ===== for underlining headings and for delineating code blocks. the other small disadvantage is that text isn't really bound to headers Surely this is true of all markup languages. How you would represent this visually in a document?
- throwawayknecht 9y ago> Surely this is true of all markup languages. How you would represent this visually in a document? An extra newline between the end of the inner part and the return to the outer part, which is what I do naturally. This can get unwieldy for breaking out of more than one level, but that's rare enough you can handle that with an alternative syntax like "--" alone to break out of two levels, "---" to break out of 3, etc. Another possibility would be picking up ASCII SI/SO again. (Emacs already makes extensive use of FF.)
- geokon 9y ago"Surely this is true of all markup languages. How you would represent this visually in a document?" Not to be snarky, but the ML in XML and HTML stands for markup language.. I'd like my markup to be easy to read and also to map to a tree hierarchy. This seems essential for parsing and anything related to literate programming and reusing "blocks" Like when I drop in a org mode clock (for logging time in my work logbook), without a tree hierarchy I have no means of binding the time to my description of the work I did. I mean... I see in visually, but its not programmatically linked as an attribute of that text block. You can kinda get around with pepperin headers everywhere, but it's not as flexible
- stewbrew 9y agoSpeaking of reasonable: I always thought the use of single character markup (e.g. * for bold), visual markup (bold instead of emphasized), several modes of emphasis (italic and bold instead of just emphasized, but maybe I just used latex for too long), and excessive "simple" markup instead of some sort of language were a mistake. I personally would rather call a simplified latex + "simple" markup for the most frequently used constructs "reasonable". I also liked the approach deplate took (http://deplate.sourceforge.net/deplate.html http://deplate.sourceforge.net/deplate.html), I would have preferred a more latex like look though. As a long term markdown user I also don't think "reasonable" is a relevant criterion. Markdown definitely is not reasonable but it's useful.
- yaccz 9y agoI find reStructuredText much better option for lightweight markup as it is comparably lightweight to markdown but there is only one version, is much more powerfull, and makes more sense to me syntactically. Org-Mode looks just like another markdown to me. > Even worse than this is the underlined heading category. I think its the best. Compared to the prefix style it actually looks like a headline in the text document. > The user is completely irritated for multiple reasons. Besides the tedious manual work to align the stupid heading characters with the heading title What is tedious on typing <esc>yyp <shift>-v r # to underline current line with #? > it is not clear what characters must be used for those heading lines. If you've got a bigger document with different levels of headings you get confused which heading character stands for which heading level. Using a convention where bigger headlines use bigger looking characters works for me. H1 uses # and is both under and overlined, the rest is only underlined H2 uses # H3 uses = H4 uses -
- yoz-y 9y agoI really like RST for documents that need 'a bit more' syntax than allowed by plain markdown. Especially references and so on. But then, the minimalism of bare bones markdown means that the text is very legible even without any special editor support.
- WorldMaker 9y ago> > The user is completely irritated for multiple reasons. Besides the tedious manual work to align the stupid heading characters with the heading title > What is tedious on typing <esc>yyp <shift>-v r # to underline current line with #? Also, there is the "easy" approach where you just fill the line instead (insert 72 #s or =s or whichever on under/over-lines). reStructuredText has a minimum fill size for a header, but not a maximum fill size. I've drafted documents that way and then trimmed the lines down to fit the headers as a last step once they have stabilized.
- sfifs 9y agoThe article doesn't really seem show any compelling use case of org mode being better than Markdown other than personal preference. Is there something feature wise I'm missing?
- addicted 9y agoI’d say the strongest point vs markdown is which version of markdown. Markdown is hardly a standard.
- CJefferson 9y agoIs org-mode a standard, beyond having only one implementation? You could just pick one markdown implementation. Other than emacs, some things have very partial orgmode implementations, but they tend to be very partial, much more different to markdown implementations.
- PMan74 9y agoAll I could think of when he said that was this: https://xkcd.com/927/ https://xkcd.com/927/
- tannhaeuser 9y agoQuestion regarding terminology: is Org-Mode (or markdown etc.) "markup"? I thought the term "markup" comes from the ability to mark-up body text with formatting instructions, as in SGML (and thus HTML and XML). I thought it's the reason why markdown is named as it is, eg. as in "non-markup". In a generalized markup (SGML) context, markdown would be called a "wiki syntax" since SGML can parse wiki syntax into eg. HTML using short references and tag inference rules, but common use of the term may have changed from the narrower SGML definition. [1]: https://en.m.wikipedia.org/wiki/Markup_language https://en.m.wikipedia.org/wiki/Markup_language
- sillysaurus3 9y agoSure. Writing: - foo Is the same as writing: <node type="list-item">foo</node> It can be parsed identically. If you just parse it into a hash table, like {type: "list-item", value: "foo"}, then all of this becomes a non-issue. It's an intermediate format, so you can take that hash table and write it out as either of the above. You could even transpile org text into HTML and vice-versa.
- Sharlin 9y agoWhat else is Markdown but body test marked with formatting instructions? Surely it doesn't matter whether emphasis is marked with asterisks or <em> tags?
- red_admiral 9y agoIt does once you need to make a numbered list where some items contain multiple paragraphs, others bulleted sub-lists, yet others images and code blocks. I'm not saying that's the best way to write a document but sometimes "port this word document to ${markup_language} for our new intranet wiki" comes from higher up and you can't question it. The <ul> tag has one great benefit: you know exactly where the list ends, namely at the </ul> tag. Your pointy-haired boss wants a list 5 levels deep where the second paragraph of item 2.4.1 needs to be at the third level of indentation, but the second paragraph of 3.1.6 needs to be indented only twice because it belongs to the 3.1 item? With opening and closing tags you make the tree structure explicit. Edge cases like this are exactly why there are six flavours of markdown (that and egoism on its creators' part) and in some of them, getting the indentation exactly as required doesn't seem to be possible at all without chucking in HTML tags.
- fsiefken 9y agoWhat would be the guidelines to write mostly markdown compatible org files? Or is there an easy way to hack org-mode to use markdown links and formatting?
- djhworld 9y agoI used org-mode for note taking and writing for about 9 months. I liked it, but there were some things that really irritated me - Exporting to other formats is not as clean cut as it first seems, especially if you use org-mode features like tags, LOG drawers etc. I always had to spend time fixing things up after the export which got annoying - It's not very easy to move from org-mode to <insert other note taking tool here> - Accessing your notes on other devices is a hit and miss affair, especially on Android devices I'd say if you're interested in using it for writing blog posts etc then you'll probably experience none of these troubles, but I'd just proceed with caution first
- stinkytaco 9y agoI've dealt with those shortcomings in the following ways: - exporting: some lisp magic can help you here, such as automatically assigning custom properties to drawers. This isn't everyone's cup of tea, but it has helped quite a bit for me. - pandoc supports org, which makes it trivial for my usecase. It may not be for everyone, but pandoc is very powerful. - Have to agree with you here. I like orgzly, but it has its shortcomings. It is nice to be able to use a plaintext editor in a pinch, however. I don't have that option with most other tools.
- Nila1936 9y agoWant to increase your business? Post ads in classified. We have world's largest classified website. Post your ads, it's free. And will be. Visit our website : http://www.myonlineplaza.com/ http://www.myonlineplaza.com/
- KhalPanda 9y agoI always liked the sound of org-mode, but as a long time vim user, I always found attempting to learn Emacs pretty jarring (I know it's just a matter of spending more time with it, but...). For what it's worth, I found vimwiki pretty good for personal organisation/journalling. https://github.com/vimwiki/vimwiki/blob/dev/README.md https://github.com/vimwiki/vimwiki/blob/dev/README.md
- thomastjeffery 9y agoIf you do want to jump into emacs, there is evil-mode. Just remember that it isn't trying to be vim, just feel like it. Personally, I have found both editors too difficult to customize since I stopped using qwerty. There are just too many default keybindings. Emacs modes all map the same keys, and remapping vim has too many edge cases.
- dragandj 9y agoFor what it's worth, I use Colemak instead of QWERTY, and just use Emacs keybindings as-is. Works great for me.
- s_kilk 9y agoI'm the same, Colemak without any rebindings, it works just fine.
- thebelal 9y agoFWIW I have been using vim with Colemak for quite a few years now, with only movie remains needed to get movement back on the home row [0] 0: https://github.com/jimhester/dotfiles/blob/master/colemak/vimrc https://github.com/jimhester/dotfiles/blob/master/colemak/vi...
- hudibras 9y agoI use vim with a Dvorak keyboard. Made a few keybinding changes (about ten or so) but that's all.
- peatmoss 9y ago
- erikb 9y agothe thing about org-mode is that it feels strongly designed for being used inside of emacs with the emacs hotkeys etc. If you do most of your stuff in emacs that's fine. But if you like me live in the shell it's not reasonable to go so deep into emacs. I want to awk/sed/grep/vim things. And if you do that with org-mode files it won't be as much fun. I use Markdown and just start to peek into Asciidoc.
- mbrock 9y agoHow does Markdown or Asciidoc differ from Org in this regard?
- stinkytaco 9y agoIt can be used and read in any text editor. Org is powerful, but it's more like Word than it is like notepad. It automatically formats tables, automatically copies and makes links internally, automatically indents, highlights code snippets, etc. And that's not even getting into further functions you can build with emacs lisp. But it is centrally dependent on emacs for that power. Markdown and asciidoc work in anything.
- type0 9y agoI agree, I switched from Org-mode mainly because Emacs is not always available. Asciidoc/Asciidoctor is so much superior for plain text editing while still being consistent. Also you don't have to use Ruby implementation if Asciidoctor.js suits your needs.
- diminish 9y agoyou live in shell - curious what type of OS you're using for work and home.
- erikb 9y agoThe only non shell tools I use are browsers and Steam, the latter one painfully mostly on Windows. Otherwise I mostly program, admin or devops around. Bash, git, vim, grep, awk, tmux, ssh are the tools I use most. Nowadays also a quite a lot of Ansible. But don't like it as much. You know, I spent nearly 10 years really learning all that stuff with the intention to use it the rest of my life. And to this point it seems to work out quite well. So no reason to learn other tools like Emacs, which would take up another few years to learn. Once you have a basic set of tools down it's more important to use it for value production.
- Schiphol 9y agoI use markdown for academic writing, and take huge advantage of related markdown extensions provided by pandoc. For example: This is normal text^[And this is a footnote, which will be rendered as such when converting to, say, LaTeX] I can also add citations [@likethisone, p. 12]. Pandoc will look up and format that bibtex reference for me. Is there anything like that for Org-Mode?
- merlincorey 9y agoorg-mode does indeed support footnotes[fn:1], but I was recently saddened to find that Github doesn't render them (it does render more basic org-mode features, though). org-ref[fn:2] has extensive support for for citations and is explicitly designed for scientific papers and output to LaTeX. [fn:1] Check out http://orgmode.org/manual/Footnotes.html http://orgmode.org/manual/Footnotes.html [fn:2] Check out https://github.com/jkitchin/org-ref/blob/master/org-ref.org https://github.com/jkitchin/org-ref/blob/master/org-ref.org
- kaushalmodi 9y ago> org-mode does indeed support footnotes[fn:1], but I was recently saddened to find that Github doesn't render them (it does render more basic org-mode features, though). GitHub uses this org-ruby project[1] to render Org files. If someone loves Org and knows Ruby too (I don't), please open PR's on that repo to improve Org parsing. [1]: https://github.com/wallyqs/org-ruby https://github.com/wallyqs/org-ruby
- peeb 9y agoSlightly off topic but I have to ask: would you be willing to share your markdown workflow for academic writing? I am very interested in graduating from latex :)
- Normal_gaussian 9y agoI would second this, having written a lot of documentation recently (markdown + template + pandoc -> pdf) I am very interested in improving this workflow.
- MattJT 9y ago"Org-mode" has a terrible, non-memorable name so it's destined to be less popular than Markdown despite clearly being better.
- Vekz 9y agoI am a dedicated org-mode user and unfortunately, I feel that this is a fair critique. Never underestimate the power of branding and unconscious bias. It's a VHS vs Betamax situation. The tech with the mindshare wins the masses.
- mih 9y agoI've been using Org-mode to make notes on math and computing. The best part is how easy it is to embed LaTeX math equations. I can simply do this: * Heading Euler's identity: \(e^{i\pi} + 1 = 0\) Then <C-c><C-e>lp to export to PDF and I have a neatly formatted document with properly rendered math. This is a lot easier than taking notes in LaTeX, and I can use any LaTeX packages. The ability to embed and execute source code makes it very easy for literate programming. Exporting to HTML or ODT is also possible.
- throwawayknecht 9y ago> Any tool that interprets Org-mode accepts this simple and easy to remember syntax. Sorry but this just isn't true. org-mode doesn't have the standardization problems Markdown does only because it's not as popular. As far as I know org-mode also doesn't have a standard, just an official implementation. And all the unofficial implementations suffer from bugs where they do something a little differently (https://github.com/bjonnh/PyOrgMode/issues/39 https://github.com/bjonnh/PyOrgMode/issues/39 , https://github.com/hsitz/VimOrganizer/issues/78 https://github.com/hsitz/VimOrganizer/issues/78 , plenty of others in every org-mode tool that doesn't just call Emacs). This isn't to malign any of the authors of these tools, but the reality is without an actual specification the problems are exactly the same as Markdown's - everyone is chasing subtle implementation details, not a clear goal. IMO, org-mode only makes sense in the context of editing within Emacs. The (enormous) value isn't in the file format, which doesn't really offer anything over GFM, but in the editing tool itself - which is difficult enough to realize inside of Emacs, let alone in any other editor - and its integration with other Emacs tools.
- peterburkimsher 9y ago+ Easy to learn + Easy to read + Good support in major text editors • Started in the emacs world • Been around since 2003 - Would put a strikethrough all the advantages above because they use the + symbol.
- juki 9y ago> Would put a strikethrough all the advantages above because they use the + symbol. No, it wouldn't. `+` is a valid list bullet in Org-mode. For strikethrough, the plus-signs must be attached to the start and end of the words (`+an example+`).
- peterburkimsher 9y agoThank you for clarifying! So it's just my phone number that will be striken-through. +88673630588+63377
- juki 9y agoNo, it wouldn't. The end plus-sign must be at the end of the word.
- Jaruzel 9y agoWhy is strikethrough not a minus sign? i.e. -strikethough-
- juki 9y agoI assume whoever made the decision figured that minus-sign is more commonly used for other purposes in text (although usually one should be using an en/em dash (which would be `--`/`---` in Org-mode) instead), so it would be harder to read (especially in text-mode where you don't see the strikethrough).
- throwawayknecht 9y ago
- MarcScott 9y agoI love org-mode, but have to write GH flavoured markdown for work. It really is a second class citizen in comparison. Org tables are sublime. I quite often fire up orgtbl-mode just to create tables easily in other text documents. Writing code blocks, in a language's major mode, is amazing. Just C-c ' and you're away, complete with your emacs tool chain, which for me means I get Python syntax highlighting, autocomplete and a PEP-8 checker. Then you can use babel to present your output. Export to html, pdf, odf works brilliantly, and I can specify a CSS sheet to style it however I want. And lastly there's https://github.com/yjwen/org-reveal https://github.com/yjwen/org-reveal which let's me make slide decks effortlessly.
- shoover 9y agoGreat examples of power features. When we started using markdown for work, I was surprised that tables were kind of a pain and pandoc's recommendation was to use Emacs and org-table.
- masklinn 9y ago> `Text <http://example.com/>`_ http://example.com/>`_ > Holy moly. This is some weird stuff. First, you have to grave accents ` and not apostrophes '. Because grave accents are rarely used on their own, and they were thus picked as rst's "meta-character" for roles (inline extensions). Apostrophes would be significantly more problematic. > Then what about the underscore character at the end? The underscore is actually how links are marked. The "core" form of external links is this: Text_ and at the bottom of the document would be .. _Text: http://example.com/ that way any instance of "Text" can be hyperlinked at little expense. Multi-word labels are simply wrapped in backticks: `This is text`_ .. _This is text: <link here> The inline form is provided as "a convenience at the expense of readability" using the generic role syntax: :role:`label <id>` where for hyperlinks `:role:` becomes an underscore postfix. > This is as complicated as you can define a simple URL. I'd even prefer the hard to type HTML version of linking. A disaster for something which has "lightweight" in its class name. rST was designed as a lightweight markup for documents, hence its support for footnotes, citations, substitutions, document fields and built-in extensions hooks (roles and directives). The "inline external hyperlink" use case wasn't much of a focus. As a criticism of rST as a lightweight markup, title denotation is probably a much better target, they look OK in plain text but are a chore to write and maintain, even with editor help.
- kuschku 9y ago> Because grave accents are rarely used on their own, and they were thus picked as rst's "meta-character" for roles (inline extensions). Apostrophes would be significantly more problematic. And they require a combination of two keys, pressed twice, on international keyboards. [Shift]+['], [Shift]+['] gives you ` If you want ```, you gotta press [Shift]+['], [Shift]+['], [Shift]+['], [Shift]+['], [Shift]+['], [Shift]+['] If your language, or any of your software, ever uses grave accents, it’s dead to me. I’m not going to do twelve key presses to mark something up For example, multiline or highlighted code in GitHub’s markdown is ```java blablabla```. That’s [Shift]+['] [Shift]+['] [Shift]+['] [Shift]+['] [Shift]+['] [Shift]+['] [j] [a] [v] [a] [Space] (...) [Shift]+['] [Shift]+['] [Shift]+['] [Shift]+['] [Shift]+['] [Shift]+[']
- 9y ago
- nnq 9y agoI see a big problems with using org-mode format with other editors than emacs, and that's why I use smth like simplified-YAML instead for notes: it doesn't lend itself well to indent-based folding (popular out-of-the-box feature in like all modern editors: Sublime, VSCode etc.). Like, if I write Heading 1: Heading 10: ... Heading 11: Heading 110: ... Heading 111: ... I can easily navigate a huge tree by using code folding to hide subsections. If heading levels are instead given by number of leading `*`s, then the editor really needs to be aware of the language. (Also, backtricks are really easy to type, I see no reason to replace them with other weird characters.)
- some1else 9y agoNo word of image embedding. Edit: Images are inlined with a link-style syntax. [[file:myimg.jpg]]
- gavinpc 9y agoNo one has mentioned metadata. Yes, Org Mode is a kitchen sink, for better or worse, but at least I can make annotations, even some structured data. Markdown doesn't even have comments. I won't criticize Markdown (or anything) for failing to achieve what it doesn't attempt, but as a programmer I consider any format with fixed semantics to be, as Bret Victor might say, "dead fish." I know XML has a bad rap (for good reasons), but at least they were trying to be extensible!
- ChrisSD 9y agoAs far as I understand it, Markdown is a superset of HTML (with some caveats). So Markdown does have comments, they're the same as HTML comments. From https://daringfireball.net/projects/markdown/syntax https://daringfireball.net/projects/markdown/syntax > For any markup that is not covered by Markdown’s syntax, you simply use HTML itself. There’s no need to preface it or delimit it to indicate that you’re switching from Markdown to HTML; you just use the tags. > The only restrictions are that block-level HTML elements — e.g. <div>, <table>, <pre>, <p>, etc. — must be separated from surrounding content by blank lines, and the start and end tags of the block should not be indented with tabs or spaces. Markdown is smart enough not to add extra (unwanted) <p> tags around HTML block-level tags.
- klibertp 9y agoNo, it's still an HTML comment - it will be present in the output generated from Markdown. If it was Markdown comment, it wouldn't show up in the output.
- WorldMaker 9y agoIf that is a feature or a bug depends on perspective and if a Markdown renderer strips HTML comments or not is an option for many of them. (That said, I do miss the reStructuredText comments sometimes in Markdown, but partly because the syntax was so simple.)
- c-cube 9y agoAs a programmer, I consider a format that is deeply tied to one particular editor as "don't touch it with a 10 foot pole". Org-mode without emacs isn't particularly attractive (I prefer markdown or asciidoc when it comes to syntax; tooling and popularity are limited). And I have no plan of learning emacs or elisp(!). In a way, org-mode is the .doc of markup languages.
- arca_vorago 9y agoI'm a bit late to the thread, but I second this. I have most of my life workflow in org now, and while the learning curve was not the easiest it has been worth it. I particularly enjoy the export options, like latex to PDF, and combined with pandoc, I can go from org to just about any format. I'm currently trying to learn to use the time tracking functions better. Emacs really is an OS. Linux is just my (current) kernel.
- cothan 9y agoI stop reading at the table syntax, look at asciidoc, much simpler. Author criticises table in other formats. But look at the table, much time taken. My markup language is the language with small effort to display what I want.
- stinkytaco 9y agoThe power of tables in org is the automatic formatting. I type |Name|Address|Something Else| and jump to the next line and put in a |- and it makes a table. I can navigate it using the tab button, it will expand columns automatically as text gets longer. It can even do some basic spreadsheet functions if you need that. Here's a video that covers it in some depth https://www.youtube.com/watch?v=fTJVLJd_gz0 https://www.youtube.com/watch?v=fTJVLJd_gz0
- kozikow 9y agoI am using org mode daily. The biggest problem is onboarding other people on the team - google docs are still easier for collaboration. Many times I wrote an initial version of the doc in org-mode and exported it to google docs for feedback and collaboration. For example, https://tensorflight.com/tutorial https://tensorflight.com/tutorial is written in org and exported to HTML via theme https://github.com/fniessen/org-html-themes https://github.com/fniessen/org-html-themes . People in the team were suggesting moving it to google docs.
- prewett 9y agoThis is nice, I pretty much already do this in my notes (like he says), except for the headings. I hate Markdown, pretty much for all the reasons he says, only I just didn't know why until now.
- ycmbntrthrwaway 9y agoSimilar but simpler markup is Muse: https://www.gnu.org/software/emacs-muse/ https://www.gnu.org/software/emacs-muse/ Wiki engine based on this markup: https://amusewiki.org/ https://amusewiki.org/
- vanderZwan 9y agoI'm surprised nobody mentioned MarkDeep as an extension to MarkDown[0]. It features a lot of convenient extras, and Morgan McGuire (who created it) has slowly been improving it over the years. https://casual-effects.com/markdeep/ https://casual-effects.com/markdeep/
- PDoyle 9y agoI'll just leave this here: https://xkcd.com/927/ https://xkcd.com/927/