Highlight.js: Include yaml in common language set

Created on 9 Nov 2017  路  9Comments  路  Source: highlightjs/highlight.js

yaml is arguably one of the most ubiquitous and popular configuration languages. Requests for it come up over and over in the Asciidoctor project, where people often use the base highlight.js bundle. Therefore, I think it's reasonable to include yaml in the base set of languages bundled in the CDN.

I have no problem submitting a PR this change. But I want to make sure the idea is met with approval first.

Most helpful comment

If this were a fringe language, I could understand. But frankly, this request is absurd. YAML is one of the most prominent configuration languages in the tech industry. Debating that fact is a waste of time.

Here's a list of high profile tools that use YAML and thus have configurations which frequently appear in documentation.

  • Ansible
  • Kubernetes
  • Docker Compose
  • Travis CI
  • Circle CI
  • GitLab CI
  • AppVeyor
  • Jekyll
  • Spring Boot
  • Monogo DB
  • Cassandra
  • RuboCop
  • Zuul
  • Coveralls
  • Istanbul
  • ESLint
  • Prometheus
  • DBUnit

Just a quick locate on my computer returns 32,000 entries for YAML files. (For reference, I have 56,000 Java files and 2 Apache HTTP conf files).

All 9 comments

It's not clear to me where the languages included in the minimized file on the CDN are defined. Can someone enlighten me?

YAML is widely used nowadays, especially in Ansible and Kubernetes manifests. Its would be great to include it into the common css file default.min.css

@mojavelinux
Is it just put Category: common at the head of src/languages/yaml.js file?
Refer to this: Remove awk.js from :common

"Common" is a special category, we use it to control the download size
of the default browser build.

That is precisely my last question.

The answer to that question is yes. I'll submit a PR.

Requests for it come up over and over in the Asciidoctor project, where people often use the base highlight.js bundle.

@mojavelinux sorry to make you do extra work, but can you provide links to the issues where people have asked for it. Want to get a sense of frequency (i.e., 3-5 requests to Asciidoctor per year or more).

If this were a fringe language, I could understand. But frankly, this request is absurd. YAML is one of the most prominent configuration languages in the tech industry. Debating that fact is a waste of time.

Here's a list of high profile tools that use YAML and thus have configurations which frequently appear in documentation.

  • Ansible
  • Kubernetes
  • Docker Compose
  • Travis CI
  • Circle CI
  • GitLab CI
  • AppVeyor
  • Jekyll
  • Spring Boot
  • Monogo DB
  • Cassandra
  • RuboCop
  • Zuul
  • Coveralls
  • Istanbul
  • ESLint
  • Prometheus
  • DBUnit

Just a quick locate on my computer returns 32,000 entries for YAML files. (For reference, I have 56,000 Java files and 2 Apache HTTP conf files).

@ mojavelinux sorry to make you do extra work, but can you provide links to the issues where people have asked for it. Want to get a sense of frequency (i.e., 3-5 requests to Asciidoctor per year or more).

I was intended to create an issue but I found there aready have one. Many maintainers and developers on github discourage user to create simillar issues, then I reused this one. So the requests per year maybe not accurate.

Another reason is that YAML is more likely used by operators and they do not care if YAML is in the common set of highlight.js of Web developing area.

YAML is populor and it would be great to include it into the common set.

The results of the community poll are in. 152 votes. 89% in favor of adding YAML to the common language set.

https://twitter.com/mojavelinux/status/1088642433703792641

Thanks @mojavelinux, I'll chat with the other maintainers and decide something soon.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Lestoroer picture Lestoroer  路  7Comments

Vad1mo picture Vad1mo  路  7Comments

Suyash2810 picture Suyash2810  路  8Comments

sustained picture sustained  路  4Comments

starikovs picture starikovs  路  8Comments