927 typedoc markdown - Githubissues

endojs / endo

Endo is a distributed secure JavaScript sandbox, based on SES

Apache License 2.0

788 stars 70 forks source link

927 typedoc markdown #2185

Closed LuqiPan closed 4 months ago

LuqiPan commented 4 months ago

closes: #XXXX refs: Agoric/documentation#927

Description

add typedoc-plugin-markdown to dev dependencies and add a typedoc-markdown script target to convert docs to markdown files
fix a raw
tag in comment which will get converted into
in .md file and as a result confuse vitepress in Agoric/documentation#1038
- to verify this indeed resolves the issue, I manually copied the generated .md file into documentation repo, added quotes and verified that vitepress could process the .md file successfully

Security Considerations

Scaling Considerations

Documentation Considerations

This is one of the blockers for Agoric/documentation#927

Testing Considerations

Compatibility Considerations

Upgrade Considerations

[ ] Includes *BREAKING*: in the commit message with migration instructions for any breaking change.
[ ] Updates NEWS.md for user-facing changes.

LuqiPan commented 4 months ago

Hmm, just noticed that I'm missing permission to merge PRs in endojs org...

Screenshot 2024-03-26 at 5 05 51 PM