Extension for asciidoctor files

KhronosGroup / OpenCL-Docs

OpenCL API, OpenCL C, Extensions, SPIR-V Environment Specs, Ref page, and C++ for OpenCL doc sources.

Other

349 stars 109 forks source link

Extension for asciidoctor files #847

Open kpet opened 1 year ago

kpet commented 1 year ago

We are currently using a mixture of mostly .txt and .asciidoc (and a couple of .adoc files). Vulkan has recently started .adoc everywhere (including for generated files) to replace mostly .txt files. Should we follow suit?

bashbaug commented 1 year ago

We should definitely rename the .txt files that actually have asciidoc source to some other extension. We've been finding creative workarounds for this for too long - see https://github.com/KhronosGroup/OpenCL-Docs/issues/450.

I don't have a strong opinion for .asciidoc vs. .adoc. Most of the asciidoc-aware tools and syntax highlighters I've seen understand both extensions.

oddhack commented 4 months ago

I see mostly things have been renamed to .asciidoc but when time for Antora comes, I believe they will have to change again to .adoc - that is hardwired in AFAICT.