Project Structure

Inside a Saber project, you may see some or all of the following folders and files:

.
├── .saber/
├── public/
├── pages/
├── static/
├── theme/
├── saber-config.js
├── saber-node.js
└── saber-browser.js

Folders:

  • .saber: Automatically generated. The files in this folder are used by Saber internally and they are not meant for modification. Should be added to the .gitignore file if not added already.
  • public: Automatically generated. The output of the build process will be exposed inside this folder. Should be added to the .gitignore file if not added already.
  • pages: Components under this folder become pages automatically with paths based on their file name. Check out the pages docs for more detail.
  • static: If you put a file into the static folder, it will not be processed by Webpack. Instead it will be copied into the public folder untouched. Check out the assets docs for more detail.
  • theme: The theme directory, you need to configure theme directory explicitly in your saber-config.js

Files:

  • saber-config.js: The Saber config file, you can write config in YAML or TOML. Check out the config docs for more details.
  • saber-browser.js: This file is where Saber expects to find any usage of the Saber browser APIs (if any). These allow customization/extension of default Saber settings affecting the browser.
  • saber-node.js: This file is where Saber expects to find any usage of the Saber node APIs (if any). These allow customization/extension of default Saber settings affecting pieces of the site build process.
Last Edited on May 13, 2019 Edit This Page on GitHub