Update 20221208.3 ️ Our favorite markup languages for documentation.md

This commit is contained in:
六开箱 2022-12-09 01:12:15 +08:00 committed by GitHub
parent 546cdfde11
commit fa8922aa48
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -26,7 +26,7 @@ We asked some of the Opensource.com contributors about their technical documenta
For the past several years, [Markdown][2] has been my standard language. But recently I decided to give [AsciiDoc][3] a try. The syntax is not difficult and [Gedit][4] on my Linux desktop supports it. I plan to stick with it for a while.
—[Alan Formy-Duval][5]
- [Alan Formy-Duval][5]
In terms of low-syntax markup, I prefer AsciiDoc. I like it because its conversion process is consistent and predictable, with no surprise "flavor" variations to confuse things. I also love that it outputs to [Docbook][6], which is a markup-heavy syntax that I trust for longevity and flexibility.
@ -52,7 +52,7 @@ AsciiDoc, as minimal as it is, just looks scarier.
If my audience is a computer that's going to parse a file, I choose AsciiDoc.
—[Seth Kenlon][8]
- [Seth Kenlon][8]
### reStructuredText
@ -60,13 +60,13 @@ I'm a big fan of [docs as code][9] and how it brings developer tools into the co
I'm also a bit of a markup connoisseur, having written whole books in AsciiDoc for O'Reilly, a lot of Markdown for various platforms, including a thousand posts on my blog. Currently, I'm a [reStructuredText][10] convert and maintain some of the tooling in that space.
—[Lorna Mitchell][11]
- [Lorna Mitchell][11]
Obligatory mention of reStructuredText. That's my go-to these days as I do a lot of Python programming. It's also been Python's standard for documentation source and code comments for ages.
I like that it doesn't suffer quite so much from the proliferation of nonstandards that Markdown does. That said, I do use a lot of Sphinx features and extensions when working on more complex documentation.
—[Jeremy Stanley][12]
- [Jeremy Stanley][12]
### HTML
@ -74,7 +74,7 @@ I rarely use markup languages if I don't have to.
I find HTML easier to use than other markup languages though.
—[Rikard Grossman-Nielsen][13]
- [Rikard Grossman-Nielsen][13]
For me, there are various ways to make documentation. It depends on where the documentation is going to be whether on a website, as part of the software package, or something downloadable.
@ -84,7 +84,7 @@ I tend to write the documentation in a plain text editor. I might use XHTML, so
Markdown has never caught on with me, and I've never tried AsciiDoc.
—[Greg Pittman][15]
- [Greg Pittman][15]
I'm writing a lot of documentation in HTML right now, so I'll put in a plug for HTML. You can use HTML to create websites, or to create documentation. Note that the two are not really the same — when you're creating websites, most designers are concerned about presentation. But when you're writing documentation, tech writers should focus on content.
@ -113,7 +113,7 @@ print_array(int *array, int size)
The great thing about HTML is you can immediately view the results with any web browser. And any documentation you write in unstyled HTML can be made prettier later by adding a stylesheet.
—[Jim Hall][16]
- [Jim Hall][16]
### Unexpected: LibreOffice
@ -133,7 +133,7 @@ Those of you laughing at me for not wanting a Ruby toolchain for AsciiDoc but be
I blush to admit that I mostly use LibreOffice these days.
—[Chris Hermansen][19]
- [Chris Hermansen][19]
### Document now!