Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Welcome to Codidact Meta!

Codidact Meta is the meta-discussion site for the Codidact community network and the Codidact software. Whether you have bug reports or feature requests, support questions or rule discussions that touch the whole network – this is the site for you.

Comments on Add support for AsciiDoc syntax

Parent

Add support for AsciiDoc syntax

+0
−2

Add support for AsciiDoc syntax.

I find their syntax very intuitive and enjoyable. For example, numbered lists start with just a period; bulleted, a star. Nested lists don't use whitespace. Links are less verbose. Have a look for yourself! This is a quick reference guide and this is a direct comparison to Markdown.

Asciidoctor has done a great job documenting everything. AsciiDoc syntax is automatically rendered on GitHub and GitLab files that have the .adoc extension.

I would expect a per-user default configuration and a possible toggle at the bottom of posts.

History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.
Why should this post be closed?

0 comment threads

Post
+6
−0

I have some concerns:

Complexity

AsciiDoc is unnecessarily complicated. From what I have seen, Codidact runs just fine on Markdown. Even much larger platform Stack Overflow doesn't seem in that much need of it, despite AsciiDoc having more features.

Worth

Considering the votes on this feature request, it seems that not a lot of users are interested. It seems like something that requires high effort[1] but gives low value in return (considering not a lot of users will use this option).

So a question that may be considered is- Is it worth the limited developer time?

Editing

You mentioned that

I would expect a per-user default configuration and a possible toggle at the bottom of posts.

While it is nice to have a per-user default configuration - think about it. This will divide all the posts into Markdown ones and AsciiDoc ones.

This poses a problem for editing.

If someone fluent with Markdown (which I think most active users are by now) wants to help and make the site better, there will be a "formatting-language" barrier that they will have to overcome if they come across a poorly written AsciiDoc post. Vice-versa for when someone fluent with AsciiDoc wants to improve a poorly written Markdown post. While I guess this barrier will not be so big, but it certainly poses an inconvenience.


  1. I'm not sure if this is just a two-minute implementation - but I think it will take time - to first add the option - then make the documentation for it in the Help Center - that too for all communities - and this isn't even taking into account the customizations some communities may have asked for. ↩︎

History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.

1 comment thread

Thanks for explaining. Here are my thoughts. (1 comment)
Thanks for explaining. Here are my thoughts.
mcp‭ wrote 10 months ago · edited 10 months ago

I appreciate you explaining. Downvotes without reason are unhelpful. I didn't know it to be complicated to implement. We'll see how time favors this request. As a workaround, I may just draft in AsciiDoc and seek an AsciiDoc to Markdown converter.

SO is a better comparison. And really formatting on a Q&A forum tends to be more minimal than formatting in a README. Not much to gain between ## vs == and I do prefer Markdown code fencing in this context.

The only syntax I'd really miss is the AsciiDoc link and list syntax. Any way those can be supported without breaking existing functionality? I'd settle happily for that compromise.