Directory Structure
Propulsion provides a starting place for the directory structure. Many of these directories correspond to a data setting in the propulsion.settings.json
file, which is documented in the configuration page. The following is a breakdown of the directories involved in the build, which are all located in the src
directory.
- catalysts
- Catalysts are what power your design system, in this folder is where you store your components and other partials. Learn more about Catalysts
- data
- The data directory is where JSON data files can be stored for use throughout your design system.
- docs
- This is where your documentation files are stored. The files in this directory should follow a specific structure and extension type (
.md
). Learn more about Documentation - schematics
- These are where the layouts for Propulsion are stored. Only one layout is necessary to get all the power of Propulsion, however you are free to create a many layouts as you’d like. Learn more about Schematics
- scripts
- Any JavaScript (or TypeScript) for your project can be found here. A few start TypeScript files can be found here.
- static
- The static folder is a place to store any static assets, such as images or other files, that are copied verbatuim into `dist`, the final build directory.
- styles
- Here is where to place your styles. Propulsion provides a starter BEM + Inverted Triangle Sass Architecture, but feel free to modify the build to use PostCSS, LESS, or vanilla!