https://github.com/freakwill/mathdown
parse markdown of math note based on pyparsing
https://github.com/freakwill/mathdown
Last synced: about 2 months ago
JSON representation
parse markdown of math note based on pyparsing
- Host: GitHub
- URL: https://github.com/freakwill/mathdown
- Owner: Freakwill
- License: mit
- Created: 2023-12-30T01:52:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-11T13:46:40.000Z (over 2 years ago)
- Last Synced: 2025-03-21T17:55:48.014Z (over 1 year ago)
- Language: Python
- Size: 102 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mathdown
`mathdown` is a markdown parser of mathematics notes, based on `pyparsing`.
## Introduction
I have made many notes on various theories in mathematics using Markdown. I need a unified format to record them for future reference. Alternatively, they can be compiled into LaTeX to generate PDFs.
## Syntax
Following is the syntax of so-called math notes.
### Paragraph
paragraphs are areas of texts, seperated by `\n\n`
```
This is a paragraph;
This is the second line of the paragraph.
This is another paragraph
The solution to the equation $f(x)=0$ is
$$
x=a+1
$$
where $a$ is ...
I hope that mathdown can help you to learn math!
```
### Block
A block is a paragraph with a keyword.
#### Theorem-type
```
**Definition**
(X, *) is a group, if ...
where ...
```
```
**Theorem**
If a, b is two points of a Hilbert space, then we have
$$
|| \leq \|a\|\|b\|
$$
Specially, in Euclidean space, ....
*Proof* Let $b = a + \lambda t,\lambda\in\R$. where $a\perp t$ and $\|t\|=1$
...
```
Or
#### Remark-type
```
*Remark* Here X is a finite set.
```
```
*Example* the set of rational numbers Q is a group.
```