PeculiarVentures / x509 / 40522924063

91%

push

github

docs: add runnable examples and update the website (#166)

* docs(website): add runnable examples and update the texts

Nine examples under website/docs/examples (certificates, requests,
revocation, chains and bundles), each a complete script with a Run
button, as on asn1js.org. They import @peculiar/x509 from src/, which a
pre-loader compiles with the root tsconfig (legacy decorators,
useDefineForClassFields: false), and are typechecked against it.

The installation page covers requirements, the Reflect polyfill, the
crypto provider, browsers and upgrading from v2; the usage page is
replaced by the examples. The landing page lists the current features.

* ci: build the website and typecheck the examples on pull requests

Replaces docs.yml with the ASN1.js website workflow: pull requests
typecheck the examples and build the site; pushes to master also deploy
it to GitHub Pages from a separate job.

* docs: link the runnable examples from the README

Replaces the long usage snippets with a short example and links to the
website examples, and documents the examples in CONTRIBUTING.md.

809 of 971 branches covered (83.32%)

Branch coverage included in aggregate %.

1663 of 1785 relevant lines covered (93.17%)

708.41 hits per line