Skip to content
Pen

Generating documentation for a package

Background

Section titled “Background”

Given a file named “pen.json” with:

{
  "type": "library",
  "dependencies": {}
}

Generate documentation for a package

Section titled “Generate documentation for a package”

Given a file named “Foo.pen” with:

# Do something nice.
Foo = \() none {
  none
}

When I run the following script:

Terminal window
pen document \
  --name Foo \
  --url https://github.com/foo/foo \
  --description "This package is cool." \
  > Foo.md

Then a file named “Foo.md” should contain “Foo package”.