search

compose-us / flottform

A better UX for file uploads #build-in-public
https://github.com/compose-us/build-in-public/blob/main/README.md#ux-improvement-for-file-uploads-in-web-forms-working-title-flottform
Other
1 stars 0 forks source link

wip: create the documentation for the module 'forms' in flottform #54

Open nidhal-labidi opened 2 months ago

nidhal-labidi commented 2 months ago

Checklist

Reviewer

Changes

Create a documentation for the module 'forms' in Flottform using TSDoc and Typedoc

nidhal-labidi commented 2 months ago

The HTML containing the documentation can be created by running the script docs defined inside the package.json file, inside the module forms.

nidhal-labidi commented 1 month ago

In the last commit (https://github.com/compose-us/flottform/pull/54/commits/0090a4dfe46bbd5656599073c0a68862c953b005) I've added a new library (https://www.npmjs.com/package/typedoc-material-theme) in order to style the docs. If you don't think that's a good idea we can remove it and just use the file forms/theme/docs-style.css to change the styles of the documentation.