ORNL / ORNL/GridKit

Latex in md files not used correctly.

Open
#578 3 comments 0 reactions 1 assignee View on GitHub

@shakedregev is already working on this.

Since Sep 11, 2026.

cleanup documentation
Dominant language
C++
Stars
27
Forks
11
Avg merge
3d 8h
Merged PRs (30d)
23

Description

Summary

In many places in the code, we use $x$, when it should be $x$ in markdown. I want to fix this. (Open this in edit mode to see the difference, apparently both render inside github).

Rationale

The latex is not rendering correctly.

Description

Change to correct markdown formatting.

Additional information

This will almost certainly merge conflict with any open documentation PR, so we should merge those first. I think a search and replace only in .md files with a clever regex should be able to fix this.
@pelesh @nkoukpaizan

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.