Directory Structure

Statusfy is designed to be easy to use and organize with Internationalization in mind, the recommended document structure is as follows:

.
├─ .statusfy/         # (internal)
├─ assets/            # (optional)
│   ├── icon.png
│   ├── img
│   │   └── logo.svg
├─ content/           # (required)
│   ├── 2018-01-16_incident_1.md
│   ├── 2018-01-17_incident_2.md
│   ├── es            # (optional)
│   │   ├── 2018-01-16_incident_1.md
│   │   └── 2018-01-17_incident_2.md
├─ locales/           # (recommended)
│   ├── en.json
│   └── es.json
├─ public/            # (optional)
│   └── robots.txt
├─ theme/             # (optional)
│   └── style.css
├─ config.js          # (optional)
└─ package.json

Note

The capitalization of the directories names is important in order to avoid errors.

  • .statusfy/: It is used to store the built files needed for your application during development or the Production Server Rendered Mode.
  • assets/: The assets directory contains your un-compiled assets such as Images.
  • content/: The Markdown source files of your Incidents. This file path can be changed, more information in the Config Reference.
  • locales/: Directory that contains translations files. More information in the Internationalization Guide.
  • public/: Static files directory. Each file inside this directory is mapped to /. For example: /public/robots.txt is mapped as /robots.txt.
  • theme/: Directory that contains the files that allow you to customize the Style of Statusfy. More information in the Theme Customization Guide.
  • config.js: Your Configuration File. More information in the Configuration Guide.
Last Updated: 11/13/2018, 8:39:22 PM
Want to keep up with the latest news, tips and tricks from Statusfy?
Subscribe to our Newsletter!