Documentation Writing Content

Folder Structure

The typical folder structure for a Bridgetown site usually looks something like this:

.
├── config # this is where frontend and server defaults are stored
├── frontend # this is where you put your CSS and JS for esbuild/Webpack
│   ├── javascript
│   │   ├── index.js
│   │   └── widget.js
│   ├── styles
│   │   ├── index.css
│   └   └── layout.css
├── server # this is where you can (optionally) add API routes using Roda
├── src # this is where you put your resources and design templates
│   ├── _components
│   │   ├── footer.liquid
│   │   └── header.liquid
│   ├── _data
│   │   ├── members.yml
│   │   └── site_metadata.yml
│   ├── _layouts
│   │   ├── default.erb
│   │   └── post.serb
│   ├── _posts
│   │   ├── 2021-09-18-enjoying-the-celebration.md
│   │   └── 2022-04-07-checking-out-bridgetown-now.md
│   ├── images
│   │   └── logo.svg
│   ├── 404.html
│   ├── some_page.md
│   └── index.html # or index.md
├── output # this is the generated site after build process
├── plugins # this is where you can write custom plugins
├── bridgetown.config.yml # this is your Bridgetown configuration file
├── config.ru # Puma uses this to boot up the web server
├── esbuild.config.js # frontend bundler config
├── Gemfile
├── Rakefile
└── package.json