You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

directory-structure.md 1.8KB

7 years ago
7 years ago
7 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. +++
  2. title = "Directory structure"
  3. weight = 3
  4. +++
  5. After running `gutenberg init`, you should see the following structure in your folder:
  6. ```bash
  7. .
  8. ├── config.toml
  9. ├── content
  10. ├── sass
  11. ├── static
  12. ├── templates
  13. └── themes
  14. 5 directories, 1 file
  15. ```
  16. Here's a high level overview of each of these folders and `config.toml`.
  17. ## `config.toml`
  18. A mandatory configuration file of Gutenberg in TOML format.
  19. It is explained in details in the [Configuration page](./documentation/getting-started/configuration.md).
  20. ## `content`
  21. Where all your markup content lies: this will most likely be mostly `.md` files.
  22. Each folder in the `content` directory represents a [section](./documentation/content/section.md)
  23. that contains [pages](./documentation/content/page.md) : your `.md` files.
  24. To learn more, read [the content overview](./documentation/content/overview.md).
  25. ## `sass`
  26. Contains the [Sass](http://sass-lang.com) files to be compiled. Non-Sass files will be ignored.
  27. The directory structure of the `sass` folder will be preserved when copying over the compiled files: a file at
  28. `sass/something/site.scss` will be compiled to `public/something/site.css`.
  29. ## `static`
  30. Contains any kind of files. All the files/folders in the `static` folder will be copied as-is in the output directory.
  31. ## `templates`
  32. Contains all the [Tera](https://tera.netlify.com) templates that will be used to render this site.
  33. Have a look at the [Templates](./documentation/templates/_index.md) to learn more on the default templates
  34. and the variables available.
  35. ## `themes`
  36. Contains themes that can be used for that site. If you are not planning to use themes, you can safely ignore
  37. this folder and let it be. If you want to learn about themes, head to the [themes documentation](./documentation/themes/_index.md).