Skip to content

Gewi413/typst-autodoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

typst-autodoc

Automaticaly generate a documentation pdf for your library using java docstring format

/**
 * this will render as info
 * @param this as a parameter
 */
#let foo(this)= {}

#import "typst-autodoc.typ": main
#main("this.typ")

example render

Supported : @param, @see, @version, @returns, more if needed

example.pdf coincidentally also documents the (few) functions of the library itself

Features

unticked boxes aren't supported (currently)

  • parse basic function /**
  • render the docstrings with typst syntax (WARNING: eval)
  • automatically insert links
  • ignore trailing docstrings
  • parse nested comments
  • parse arguments with default arrays/dictionariess
  • parse variables

About

A documentation renderer for typst libraries

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published