[Definitions] Enhance with markdown - #238
Merged
Merged
Conversation
Merged
stratoula
pushed a commit
that referenced
this pull request
Sep 2, 2026
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @elastic/esql-definitions@4.23.0 ### Minor Changes - [#238](#238) [`a5f1919`](a5f1919) Thanks [@stratoula](https://github.com/stratoula)! - Add `markdown` field to `DefinitionDocs` for ES|QL functions and operators. The field contains the full markdown documentation sourced from the corresponding `.md` file in `elasticsearch/esql/<project>/docs/`, with the leading generator comment line stripped. This allows consumers to display rich documentation without needing direct access to the Elasticsearch source repository. ## @elastic/esql@4.23.0 ### Patch Changes - Updated dependencies [[`a5f1919`](a5f1919)]: - @elastic/esql-definitions@4.23.0 - @elastic/esql-types@4.23.0 - @elastic/esql-grammar@4.23.0 - @elastic/esql-promql-grammar@4.23.0 - @elastic/pretty-printer@4.23.0 - @elastic/esql-traversal@4.23.0 - @elastic/esql-parser@4.23.0 - @elastic/esql-ast@4.23.0 ## @elastic/esql-ast@4.23.0 ### Patch Changes - Updated dependencies [[`a5f1919`](a5f1919)]: - @elastic/esql-definitions@4.23.0 - @elastic/esql-types@4.23.0 - @elastic/esql-grammar@4.23.0 - @elastic/esql-promql-grammar@4.23.0 ## @elastic/elasticsearch-esql-dsl@4.23.0 ### Patch Changes - Updated dependencies []: - @elastic/elasticsearch-query-builder@4.23.0 ## @elastic/esql-parser@4.23.0 ### Patch Changes - Updated dependencies [[`a5f1919`](a5f1919)]: - @elastic/esql-definitions@4.23.0 - @elastic/esql-types@4.23.0 - @elastic/esql-promql-grammar@4.23.0 - @elastic/esql-traversal@4.23.0 - @elastic/esql-ast@4.23.0 ## @elastic/esql-traversal@4.23.0 ### Patch Changes - Updated dependencies []: - @elastic/esql-types@4.23.0 - @elastic/esql-ast@4.23.0 ## @elastic/highlightjs-esql@4.23.0 ### Patch Changes - Updated dependencies [[`a5f1919`](a5f1919)]: - @elastic/esql-definitions@4.23.0 ## @elastic/monaco-esql@4.23.0 ### Patch Changes - Updated dependencies [[`a5f1919`](a5f1919)]: - @elastic/esql-definitions@4.23.0 ## @elastic/prismjs-esql@4.23.0 ### Patch Changes - Updated dependencies [[`a5f1919`](a5f1919)]: - @elastic/esql-definitions@4.23.0 ## @elastic/textmate-esql@4.23.0 ### Patch Changes - Updated dependencies [[`a5f1919`](a5f1919)]: - @elastic/esql-definitions@4.23.0 ## @elastic/esql-grammar@4.23.0 ## @elastic/esql-promql-grammar@4.23.0 ## @elastic/esql-types@4.23.0 ## @elastic/pretty-printer@4.23.0 ## @elastic/elasticsearch-query-builder@4.23.0 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
I want to use this package to kibana in order to build the definitions and docs using this and not have a job that is cloning again ES. In order to do so there is the markdown missing. This PR is enhancing the package to contain thins info too
Checklist
yarn changeset) if this change should be released. See docs/RELEASE.md.