-
-
Notifications
You must be signed in to change notification settings - Fork 5.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add KaTeX rendering to Markdown. (#20571)
This PR adds mathematical rendering with KaTeX. The first step is to add a Goldmark extension that detects the latex (and tex) mathematics delimiters. The second step to make this extension only run if math support is enabled. The second step is to then add KaTeX CSS and JS to the head which will load after the dom is rendered. Fix #3445 Signed-off-by: Andrew Thornton <[email protected]> Signed-off-by: Andrew Thornton <[email protected]> Co-authored-by: silverwind <[email protected]> Co-authored-by: Lunny Xiao <[email protected]>
- Loading branch information
3 people
committed
Sep 13, 2022
1 parent
eaa5611
commit 88c2e24
Showing
28 changed files
with
1,077 additions
and
172 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| // Copyright 2022 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package markdown | ||
|
|
||
| import ( | ||
| "github.com/yuin/goldmark/ast" | ||
| east "github.com/yuin/goldmark/extension/ast" | ||
| "gopkg.in/yaml.v3" | ||
| ) | ||
|
|
||
| func nodeToTable(meta *yaml.Node) ast.Node { | ||
| for { | ||
| if meta == nil { | ||
| return nil | ||
| } | ||
| switch meta.Kind { | ||
| case yaml.DocumentNode: | ||
| meta = meta.Content[0] | ||
| continue | ||
| default: | ||
| } | ||
| break | ||
| } | ||
| switch meta.Kind { | ||
| case yaml.MappingNode: | ||
| return mappingNodeToTable(meta) | ||
| case yaml.SequenceNode: | ||
| return sequenceNodeToTable(meta) | ||
| default: | ||
| return ast.NewString([]byte(meta.Value)) | ||
| } | ||
| } | ||
|
|
||
| func mappingNodeToTable(meta *yaml.Node) ast.Node { | ||
| table := east.NewTable() | ||
| alignments := []east.Alignment{} | ||
| for i := 0; i < len(meta.Content); i += 2 { | ||
| alignments = append(alignments, east.AlignNone) | ||
| } | ||
|
|
||
| headerRow := east.NewTableRow(alignments) | ||
| valueRow := east.NewTableRow(alignments) | ||
| for i := 0; i < len(meta.Content); i += 2 { | ||
| cell := east.NewTableCell() | ||
|
|
||
| cell.AppendChild(cell, nodeToTable(meta.Content[i])) | ||
| headerRow.AppendChild(headerRow, cell) | ||
|
|
||
| if i+1 < len(meta.Content) { | ||
| cell = east.NewTableCell() | ||
| cell.AppendChild(cell, nodeToTable(meta.Content[i+1])) | ||
| valueRow.AppendChild(valueRow, cell) | ||
| } | ||
| } | ||
|
|
||
| table.AppendChild(table, east.NewTableHeader(headerRow)) | ||
| table.AppendChild(table, valueRow) | ||
| return table | ||
| } | ||
|
|
||
| func sequenceNodeToTable(meta *yaml.Node) ast.Node { | ||
| table := east.NewTable() | ||
| alignments := []east.Alignment{east.AlignNone} | ||
| for _, item := range meta.Content { | ||
| row := east.NewTableRow(alignments) | ||
| cell := east.NewTableCell() | ||
| cell.AppendChild(cell, nodeToTable(item)) | ||
| row.AppendChild(row, cell) | ||
| table.AppendChild(table, row) | ||
| } | ||
| return table | ||
| } | ||
|
|
||
| func nodeToDetails(meta *yaml.Node, icon string) ast.Node { | ||
| details := NewDetails() | ||
| summary := NewSummary() | ||
| summary.AppendChild(summary, NewIcon(icon)) | ||
| details.AppendChild(details, summary) | ||
| details.AppendChild(details, nodeToTable(meta)) | ||
|
|
||
| return details | ||
| } |
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| // Copyright 2022 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package math | ||
|
|
||
| import "github.com/yuin/goldmark/ast" | ||
|
|
||
| // Block represents a display math block e.g. $$...$$ or \[...\] | ||
| type Block struct { | ||
| ast.BaseBlock | ||
| Dollars bool | ||
| Indent int | ||
| Closed bool | ||
| } | ||
|
|
||
| // KindBlock is the node kind for math blocks | ||
| var KindBlock = ast.NewNodeKind("MathBlock") | ||
|
|
||
| // NewBlock creates a new math Block | ||
| func NewBlock(dollars bool, indent int) *Block { | ||
| return &Block{ | ||
| Dollars: dollars, | ||
| Indent: indent, | ||
| } | ||
| } | ||
|
|
||
| // Dump dumps the block to a string | ||
| func (n *Block) Dump(source []byte, level int) { | ||
| m := map[string]string{} | ||
| ast.DumpHelper(n, source, level, m, nil) | ||
| } | ||
|
|
||
| // Kind returns KindBlock for math Blocks | ||
| func (n *Block) Kind() ast.NodeKind { | ||
| return KindBlock | ||
| } | ||
|
|
||
| // IsRaw returns true as this block should not be processed further | ||
| func (n *Block) IsRaw() bool { | ||
| return true | ||
| } |
Oops, something went wrong.