chore!: upgrade mdex to 0.13#185
Open
halostatue wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Note that this builds on #184 (which is why there are two commits). |
If a Tableau blog uses MDEx syntax highlighting, the latest version of
MDEx has breaking changes to how syntax highlighting works and your blog
configuration must be modified for it to continue working.
There are two supported syntax highlighters: Lumis (tree-sitter) and
Syntect (Sublime Text grammars). Tableau includes the Lumis syntax
highlighter package, but it is not fully configured without modification
to the blog `config/config.exs` for selecting the appropriate syntax
highlighting NIF:
```elixir
config :mdex_native, syntax_highlighter: :lumis
config :mdex_native, syntax_highlighter: :syntect
```
The MDEx options configuration must also be updated:
```diff
render: [unsafe: true],
syntax_highlight: [
- formatter: {:html_inline, theme: "neovim_dark"}
+ engine: :lumis,
+ opts: [formatter: {:html_inline, theme: "neovim_dark"}]
],
plugins: [MDExGFM]
```
More details for each syntax highlighter can be found at
https://mdex.hexdocs.pm/lumis.html or
https://mdex.hexdocs.pm/syntect.html.
Collaborator
|
Thanks, this looks straightforward. I'm going to try this branch on my personal blog before merging. Note to self: update the tableau_new mix archive as well. |
Contributor
Author
|
I think the biggest trick is going to be making sure that the new version's release notes are clear on what needs to be done because it's not quite a routine release. I haven't been able to get my latest blog published, but that's an infra issue on my end not a Tableau problem where I was using the git version yesterday for everything. |
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
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.
If a Tableau blog uses MDEx syntax highlighting, the latest version of MDEx has breaking changes to how syntax highlighting works and your blog configuration must be modified for it to continue working.
There are two supported syntax highlighters: Lumis (tree-sitter) and Syntect (Sublime Text grammars). Tableau includes the Lumis syntax highlighter package, but it is not fully configured without modification to the blog
config/config.exsfor selecting the appropriate syntax highlighting NIF:The MDEx options configuration must also be updated:
render: [unsafe: true], syntax_highlight: [ - formatter: {:html_inline, theme: "neovim_dark"} + engine: :lumis, + opts: [formatter: {:html_inline, theme: "neovim_dark"}] ], plugins: [MDExGFM]More details for each syntax highlighter can be found at https://mdex.hexdocs.pm/lumis.html or https://mdex.hexdocs.pm/syntect.html.