In this article, we look into the directory structure of the downloaded package. The default directory structure is intended to provide a great starting point for both large and small documentations. Of course, you are free to organize your documentation however you like.
Once downloaded, unzip the compressed folder and you’ll see something like this:
thedocs/ ├── starter/ ├── theme/ └── v1.5/
Let's see what's inside each directory and what are the pupose of each one.
It includes starter templates to get started with. This is the place you should choose a starter, copy a directory and start your project with. There's a complete documentation inside a readme.html file for each starter template.
This directory contains all the files that you see in the online demo. You should use these files to copy codes or files from and develop your own project. Also, it's a documentation and reference for our components.
The previous major release of TheDocs which is included for thousands od customers who has developed their project based on the v1.x.
You can see this folder contains following structure:
assets/ ├── css/ ├── fonts/ ├── img/ ├── js/ ├── php/ └── plugin/
As you can see, the name of sub-folders represent its responsibility.
The css folder contains following files and directory:
- page.css: Unminified version of TheDocs styles
- page.min.css: Minified version of TheDocs styles
- style.css: Your custom styles
The fonts directory contains all files that used in our template. If you want to use local fonts and import them in your css file, you'd better to place your font files inside this folder.
This folder houses your image files that you want to use in your template, such as logo, favicon, etc.
The js folder contains following files:
This directory contains all the PHP files which is somehow required for functionality of template, such as sending emails for contact us page.
While we included necessary 3rd party plugins inside core.min.js, but there is some possibilities that you would like to use other plugins in your template. This folder is the place that you should place those plugins inside.