A little known fact, even among most org-users: Github can render org-mode files to HTML directly if checked into a repo, thus you can write your README files as org-files.
Shameless example: https://github.com/josteink/csharp-mode/blob/master/README.o...
This alone was enough to make me drop Markdown as my go-to format for semi-formatted text-files.
A subtle killer feature here is org-babel. You can embed proper code in your text-files and have your editor (at least Emacs) understand them as such. Which makes it excellent for writing technical documentation for projects where code is involved.
They also support ASCIIDoc, ReST, MediaWiki markup, Creole, etc.
I recently stumbled across the tidbit. The Ruby library Github uses to generate it though isn't 100% though. If you want to use org-mode properties for style customization of html output your SOL.
Original project:
https://github.com/bdewey/org-ruby
Currently, you cannot do much to customize the conversion. The
supplied textile conversion is optimized for extracting “content”
from the orgfile as opposed to “metadata.”
It does say that developement has moved to:https://github.com/wallyqs/org-ruby
Which has no such note, but doesn't say anything about supporting it.
+ Name + Occupation
| Alice | Accountant
| Bob | Baker
| Charles | Car salesman
Headers are easier to make and the last column does not require a trailing marker. It's still some work to align columns other than the last, but that's not a requirement and I'd still much rather have a non-aligned ASCII table than nothing at all. |-----+-------|
| Key | Value |
|-----+-------|
| 00 | foo |
| 01 | bar |
|-----+-------|
becomes |-----+-------|
| Key | Value |
|-----+-------|
| 00 | foo |
| 01 | bar |
| 02 | much longer |
|-----+-------|
but as soon as I hit TAB, it turns in to: |-----+-------------|
| Key | Value |
|-----+-------------|
| 00 | foo |
| 01 | bar |
| 02 | much longer |
|-----+-------------|
There's probably a way to make org-mode dynamically resize tables as you type, without requiring the use of TAB, but I'm not sure if that's always desirable.More seriously, ASCII tables are always a major pain to edit, without the proper tools (like emacs—and I'd not be at all surprised if there's something for vim and/or Sublime Text too). That's no reason to avoid them; they are useful.
Here's an example, displayed exactly how you would see it marked up in org-mode syntax in emacs:
org-mode can export to HTML, and many other formats.