Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite in ASCIIDoc #38

Open
meagar opened this issue Nov 6, 2024 · 1 comment
Open

Rewrite in ASCIIDoc #38

meagar opened this issue Nov 6, 2024 · 1 comment

Comments

@meagar
Copy link

meagar commented Nov 6, 2024

ASCIIDoc is a superior markdown, meant to be complete enough to typeset a book. Indeed, many published books are written entirely in ASCIIDoc, and the ability to compile an ASCIIDoc site to HTML/PDF/EPub/DocBook/etc. is "built-in".

It additionally contains many useful features for technical books like callouts for source code blocks, footnotes, example blocks, etc.

The only thing Markdown has going for it is approachability, which is admittedly not nothing, but it's not a great effort to learn ASCIIDoc if you already know Markdown.

I'm curious if an ASCIIDoc rewrite would be considered - I think it's a good idea in the long run, and the longer the rewrite is delayed, the harder it becomes.

@alp1n3-eth
Copy link

I think the main concerns for this would be maintenance and contributions.

In terms of maintenance, it would require someone to re-write / convert the preexisting files over. In terms of contributions, it may make new contributors less likely to participate, as they don't want to learn yet another markup language.

Markdown is supported in many more areas than ASCIIDoc and has much more support & extensions. The OWASP Cheatsheet Series uses markdown as well. While ASCIIDoc is really nice, and it is much handier for long-form books that will be distributed via epub/PDF/etc., but since this is a doc site it doesn't seem needed.

Ofc, that's up to pilcrow, but I thought I'd toss in my $0.02.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants