pandas-markdown-parser/grammer.md

# meta data


yaml can be defined at the start of a file to define meta data
```md
---
# yaml
---
```

# headings
these are standard markdown headings

```md
# heading 1
## heading 2
### heading 3
#### heading 4
##### heading 5
###### heading 6
```

# text and inline styles

## text

just some text man dont know what to tell you
```
plain test
```

## inline styles
all inline styles must start with a space and end with a space
however these are just the defualt ones and can be changed within the meta data as well as the ablity to add custom ones

### code
```md
`plain test`
```

### bold
```md
!plain test!
```

### italic
```md
*plain test*
```

### underline
```md
_plain test_
```

### strikethrough
```md
~plain test~
```

### highlighted
```md
|plain test|
```

all style chars:
```
named : `!*_~|
unamed : &%$#-+=
```

### super script
```md
sometext^{}
```
### sub script
```md
sometext_2
```

# lists


## ordered
```md
1. ordered list
2. ordered list
3. ordered list
```

```md
i. ordered list
ii. ordered list
iii. ordered list
```

```md
a. ordered list
b. ordered list
c. ordered list
```

## unordered

```md
- unordered list
- unordered list
- unordered list
```

```md
= unordered list
= unordered list
= unordered list
```

```md
+ unordered list
+ unordered list
+ unordered list
```

```md
* unordered list
* unordered list
* unordered list
```

# embeds

```md
![figure text](relitive path to image)
```

```md
#[table text](relitive path to tabulated data)
```

```md
$[file text](path to file#starting_line:ending_line)
```

embed file chars:
```
named : !#$
unamed : *_~|&%-+=
```

```md
/[file text](link to something)
```

# tables

```
| col | col | col |
| --- | --- | --- |
| row | row | row |  
| row | row | row |  
| row | row | row |  
| row | row | row |  
| --- | --- | --- |
| col | col | col |
| --- | --- | --- |
| row | row | row |  
| row | row | row |  
| row | row | row |  
| row | row | row |  
```

# quote blocks

```md
> quote
> quote
> quote
```

```md
| quote
| quote
| quote
```

# text/code blocks

```
\```
some text or code
\```
```

```
\```lang_name
some text or code
\```
```

the passthough lang name will just place what is in the box within the output
```
\```passthough
some text or code
\```
```

# comments

everything after the commnet identifier is a comment until the next line
```md
// this is a comment
```

# tick box
```md
- [ ] something to check off
- [x] something checked off
- [/] something ticked off
- [~] something dashed off
```

# horrazontal rules
```md
--- // straight line
=== // double straight line
*** // big dotted straight line
... // small dotted line
&&& // squiggly line
^^^ // jagged line
```

# footnote

```md
sometext [^1]

[^1]: footnote
```

# advanced features

## custom styles
any of the above features can have style overrides
it beings with a . to differnate it from other functions
```md
@.styles()
# heading 7
```

## citations

```md
---
refs: refs.bib
---

@cite(panda)

@bib()
```

## replacements

```md
---
replacement: 
    toads: "frogs"
---

@toads
```
-->
```
frogs
```

## replacement macros
```md
---
macros: 
    hello:
        args:
            name : "str"
            age  : "number"
        code:
            "hello my name is {name} and i am {age} years old"
---


@hello("panda", 240)
```
-->
```
hello my name is panda and i am 240 years old
```

## numerical macros

```
---
macros: 
    add:
        args:
            num1 : "number"
            num2 : "number"
        eq:
            num1 + num2
---

@add(1, 2)
```
-->
```
3
```

## cli macros

```
---
macros: 
    generate_figure:
        args:
            filename : "str"
        cmd:
            python generate_figure.py {filename}
        post_process:
            "![figure of data from {filename}]({out})"
---

@generate_figure("data/run2.csv")
```
-->
```
![figure of data from data/run2.csv](figure.png)
```


## heading id override 

```md
@.id(heading-1-overide)
@.style()
# heading 1 

@.id(heading-2-overide)
@.style()
## heading 2 

@.id(heading-3-overide)
@.style()
### heading 3 

@.id(heading-4-overide)
@.style()
#### heading 4 

@.id(heading-5-overide)
@.style()
##### heading 5 

@.id(heading-6-overide)
@.style()
###### heading 6 

```