Files

2026-04-14 21:31:44 +12:00

4.1 KiB

Raw Blame History

meta data

yaml can be defined at the start of a file to define meta data

---
# yaml
---

headings

these are standard markdown headings

# 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

`plain test`

bold

!plain test!

italic

*plain test*

underline

_plain test_

strikethrough

~plain test~

highlighted

|plain test|

all style chars:

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

super script

sometext^{}

sub script

sometext_2

lists

ordered

1. ordered list
2. ordered list
3. ordered list

i. ordered list
ii. ordered list
iii. ordered list

a. ordered list
b. ordered list
c. ordered list

unordered

- unordered list
- unordered list
- unordered list

= unordered list
= unordered list
= unordered list

+ unordered list
+ unordered list
+ unordered list

* unordered list
* unordered list
* unordered list

embeds

![figure text](relitive path to image)

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

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

embed file chars:

named : !#$
unamed : *_~|&%-+=

/[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

> quote
> quote
> quote

| 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

// this is a comment

tick box

- [ ] something to check off
- [x] something checked off
- [/] something ticked off
- [~] something dashed off

horrazontal rules

--- // straight line
=== // double straight line
*** // big dotted straight line
... // small dotted line
&&& // squiggly line
^^^ // jagged line

footnote

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

@.styles()
# heading 7

citations

---
refs: refs.bib
---

@cite(panda)

@bib()

replacements

---
replacement: 
    toads: "frogs"
---

@toads

-->

frogs

replacement macros

---
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)

-->

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

@.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

4.1 KiB Raw Blame History