pdftron-react-native icon indicating copy to clipboard operation
pdftron-react-native copied to clipboard

Use JSDoc comments for documentation

Open akwanpdf opened this issue 4 years ago • 0 comments

This update changes the way APIs will be documented in this repo. Instead of being written in API.md, docs will now be written in the source files using JSDoc comments (see API documentation wiki for guide to creating/editing/publishing docs).

Viewing docs This update allows HTML files to be generated for these docs. To see the doc files in your browser, click any API hyperlink in the README or click here.

Generating docs locally To generate local doc files, run npm start in the outer repo's example folder, then open these files in your browser to see any changes you made.

Docs for users GitHub Actions will automatically generate docs in master.

Doc website template Currently we are using a forked version of DocStrap edited to work for this library.

akwanpdf avatar Sep 23 '21 23:09 akwanpdf