jneug / typst-mantys

Template for documenting Typst Packages and Templates.
MIT License
41 stars 5 forks source link

README.md uses invalid syntax for sections #22

Open cskeeters opened 4 months ago

cskeeters commented 4 months ago

In section Writing basics of the README.md, the example should use = for headings.

# About
#lorem(50)

# Usage
#lorem(50)

# Available commands
#lorem(50)

Should be:

= About
#lorem(50)

= Usage
#lorem(50)

= Available commands
#lorem(50)
cskeeters commented 4 months ago

While not important, I also suggest commenting out the following two lines so the example will compile and potential users can see what the template looks like.

// #import "your-package.typ"

and

// example-imports: (your-package: your-package)