Skip to content

Conversation

@tsouza
Copy link

@tsouza tsouza commented Dec 6, 2018

This adds support to Kibana Dev Tools syntax like:

GET _search?q=some text

POST /logstash-*/_search
{
    "size": 100,
    "query": { "match_all": {} },
    "aggs": {
        "price_avg": { 
            "avg": { "field": "price" }
        }
    }
}

@joshgoebel joshgoebel changed the title Adding Kibana Dev Tools language Add Kibana Dev Tools Oct 24, 2019
@joshgoebel
Copy link
Member

@tsouza

First of all, truly sorry for the long delay in anyone responding to this PR.

Thank you so much for desiring to contribute and writing a language grammar. Unfortunately, we currently are no longer accepting new languages into the core repository. The existing library maintainers don't simply have time to maintain any new languages (fixing bugs, dealing with issues, etc). We'd still love to host your language as a 3rd party module though - if you're willing to help maintain it.

It's easy to turn your language into a module that anyone who likes can easily integrate with Highlight.js using a single line of code:

<script src="/path/to/highlight.min.js"></script>
<!-- they'd simply add this single line -->
<script src="/path/to/highlightjs-kibana.js"></script> 
<script>hljs.initHighlightingOnLoad();</script>

If you'd like to become the maintainer for this language then we're happy to create a new repository in the highlightjs organization and host the repository there. That assumes you'd be open to reviewing issues and fixing bugs as they arise. You're also welcome to host the repo yourself and we'll link to it from our README.

There isn't much in the way of how to docs on this yet, but there are sample repositories and it's honestly pretty easy. We're still fleshing out an official "spec" for 3rd party modules, but even after that's done it should require minimal changes from the examples we have already. IE, if you wanted to get started now there isn't any big reason to wait.

My own robots.txt grammar repository is a great, simple example:

https://github.com/highlightjs/highlightjs-robots-txt

If you have any questions feel free to ask.

@joshgoebel
Copy link
Member

Closing for inactivity; (also finally cleaning all these old PRs out for the new year).

As mentioned above if you're interested in becoming the maintainer of a 3rd party module, please respond [whenever you find time] and we'd be happy to help you get started.

@joshgoebel joshgoebel closed this Jan 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants