search

earthstar-project / stone-soup

A specification and Javascript library for building online tools you can truly call your own.
https://earthstar-project.org
GNU Lesser General Public License v3.0
4 stars 2 forks source link

set up Typedoc #30

Closed cinnamon-bun closed 2 years ago

cinnamon-bun commented 3 years ago

Copy the typedoc config over from the main earthstar repo (look in package.json)

Typedoc auto-generates HTML files documenting your classes.

shravankb commented 3 years ago

Hi @cinnamon-bun I would like to take this issue up!

cinnamon-bun commented 3 years ago

@shravankb Hi thanks!

You can fork this stone-soup repo, and modify the package.json to include the lines from here...

https://github.com/earthstar-project/earthstar/blob/main/package.json

that mention typedoc. Then make a pull request and I'll merge it here.

cinnamon-bun commented 2 years ago

See also #139 "add JSDocs"

sgwilym commented 2 years ago

Superseded by #139