Directory structure
A basic Nacara project have a structure similar to this:
├── docs
│ ├── _partials
│ │ └── [...]
│ ├── documentation
│ │ └── [...]
│ ├── scss
│ │ └── [...]
│ └── style.scss
├── docs_deploy
│ └── [...]
├── lightner
│ ├── grammars
│ └── themes
├── nacara.config.json
├── package.json
To understand it better, we present this overview:
File / Directory | Description |
---|---|
.nacara | Internal folder where Nacara put generated or cached files You should add this folder to your |
docs | Default folder where you place your website source files like:
|
docs/style.scss or docs/style.sass | Main entry file for styling your application, generated file will be Only one of those files should be used at a time. |
docs/scss or docs/sass | This is where you place your SASS/SCSS files imported by style.scss . |
docs/_partials | This is where you place your partials files like footer.jsx |
docs_deploy | This is where Nacara will put the generated files (by default). You should add this folder to your |
lightner/themes | Recommended place to place your theme file user by Code-lightner to provides code highlights. |
lightner/grammars | Recommended place to place your grammars files user by Code-lightner to provides code highlights. |
nacara.config.json | Nacara config file. |
package.json | File used to configure your NPM dependencies like Nacara, Babel, nacara-layout-standard. |
docs/index.md or docs/**/*.md | Any markdown file encounter are going to be transform by Nacara into HTML using the layout provided via the front-matter property. |
docs/**/*.fs or docs/**/*.fsx | F# files are tested to see if there are literate files. If they are, they are transformed like as markdown files. If not, there are copied as is to the output folder. |
docs/**/menu.json | Menu configuration for the section it is in. |
Other files or folders | Except for the special cases listed above, all the other file and folder will be copied into the destination folder. |