search

uswds / uswds-site

USWDS website and documentation
https://designsystem.digital.gov
Other
184 stars 140 forks source link

USWDS-Site - Documentation: Add asset compilation instructions #2472

Open mahoneycm opened 5 months ago

mahoneycm commented 5 months ago

Is your feature request related to a problem? Please describe.

When using USWDS Compile, users use the uswds.init script to copy USWDS assets out of the USWDS package and into a /assets directory at the root of the project.

When users are using a different compiler to compile USWDS code, they often run into issues surrounding USWDS image and font assets because they are not copying these assets out of the USWDS package. Because of this, we've had multiple requests from users who are using USWDS with a JS framework like Angular, React, or Vite who run into compilation errors because the compiler cannot find the assets.

Describe the solution you'd like

Enhance compilation documentation to include instructions on copying USWDS assets into root project.

Describe alternatives you've considered

No response

Additional context

Recent issue with resolution in comments: https://github.com/uswds/uswds/issues/5097

Code of Conduct

amyleadem commented 1 month ago

Tasks