File Structures Specification

Since Bissetii is a multi-role module, the file structures must be documented specifically for future engineering betterment. That way, communications between developers can be aligned correctly for synchonous contributions.

Below are the specification for the key file structures in Bissetii Hugo Theme and Go Template Module.

app

app/
 ย ย  โ””โ”€โ”€ bissetii.sh

app directory holds the source codes for Bissetii application program.

archetypes

archetypes/
    โ”œโ”€โ”€ default.md
 ย ย  โ””โ”€โ”€ redirect.md

This serves Hugo’s default page creation template. For bissetii, a default.md is in placed to handle all the default values.

assets

assets/
โ”œโ”€โ”€ css/
โ”‚ย ย  โ”œโ”€โ”€ bissetii/
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ _Render.sass
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ ...
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ templates
โ”‚ย ย  โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ ...
โ”‚ย ย  โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ modules/
โ”‚ย ย  โ”‚ย ย      โ”œโ”€โ”€ core/
โ”‚ย ย  โ”‚ย ย      โ”‚    โ”œโ”€โ”€ _Base.scss
โ”‚ย ย  โ”‚ย ย      โ”‚    โ”œโ”€โ”€ _Blockquote.scss
โ”‚ย ย  โ”‚ย ย      โ”‚ย  ย  โ””โ”€โ”€ ...
โ”‚ย ย  โ”‚ย ย      โ”œโ”€โ”€ emoji/
โ”‚ย ย  โ”‚ย ย      โ”‚    โ”œโ”€โ”€ _CustomEmoji.scss
โ”‚ย ย  โ”‚ย ย      โ”‚    โ”œโ”€โ”€ _NotoColorEmoji.scss
โ”‚ย ย  โ”‚ย ย      โ”‚ย  ย  โ””โ”€โ”€ ...
โ”‚ย ย  โ”‚ย ย      โ””โ”€โ”€ ...
โ”‚ย ย  โ”œโ”€โ”€ desktop.sass
โ”‚ย ย  โ”œโ”€โ”€ main.sass
โ”‚ย ย  โ”œโ”€โ”€ ...
โ”‚ย ย  โ””โ”€โ”€ print.sass
โ””โ”€โ”€ js/
 ย ย  โ”œโ”€โ”€ coreLib/
 ย ย  โ”‚ย ย  โ”œโ”€โ”€ core.js
 ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
 ย ย  โ””โ”€โ”€ ...

These are the Sass and Javascript asset components for Bissetii.

This directory must be compatible for:

  1. Hugo Theme (assets/).
  2. Sass Engine.

The css directory holds the master main.sass that serves as the primary css configurations for a Hugo engine. the bissetii inside this directory holds the Sass files for generating the final CSS output.

The js directory holds all Javascripts, ready to be fused and minified together.

config

config/
 ย ย  โ””โ”€โ”€ _default/
 ย ย      โ”œโ”€โ”€ config.toml
 ย ย      โ”œโ”€โ”€ ...
 ย ย      โ””โ”€โ”€ params.toml

config is the master template for .sites engine’s (or Hugo’s) config directoy. It is used to quickly setup a local Hugo repository fully configured for Bisseti.

This directory must be compatible for:

  1. Hugo themes (config/)

.configs

bissetii/
โ”œโ”€โ”€ .configs/
โ”‚ย ย  โ””โ”€โ”€ ...
...

.configs directory holds all configurations for Bissetii’s GitLab CI automation purposes.

data

data/
โ”œโ”€โ”€ bissetii/
โ”‚ย ย  โ”œโ”€โ”€ ...
โ”‚ย ย  โ”œโ”€โ”€ data/
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
โ”‚ย ย  โ”œโ”€โ”€ defaults.toml
โ”‚ย ย  โ”œโ”€โ”€ includes.toml
โ”‚ย ย  โ”œโ”€โ”€ navbars.toml
โ”‚ย ย  โ”œโ”€โ”€ schema/
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ SoftwareApplication.toml
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
โ”‚ย ย  โ”œโ”€โ”€ thumbnails.toml
โ”‚ย ย  โ””โ”€โ”€ vendors/
โ”‚ย ย      โ”œโ”€โ”€ google.toml
โ”‚ย ย      โ””โ”€โ”€ ...
โ””โ”€โ”€ creators.toml

Holds data essentials for Hugo Theme with local dataset and bissetii Hugo Theme configuration files. For all Bissetii configurations, it is located in data/bissetii/ directory.

Anything outside of Bissetii configurations directory is meant to serve as the local dataset for users to be overwritten.

This directory must be compatible with:

  1. Hugo Theme (data/).
  2. Go Programming Language.

docs

docs/
 ย ย  โ”œโ”€โ”€ en-us/
 ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
 ย ย  โ””โ”€โ”€ zh-cn/
 ย ย      โ””โ”€โ”€ ...

Holds Bissetii’s documentations. It is powered by the local .sites website generator.

This directory must be compatible for:

  1. Hugo Theme (docs/).

.fennec

.fennec/
 ย ย  โ””โ”€โ”€ ...

Bissetii’s GitLab CI support module. Bissetti uses Fennec to drive most of its continuous integration works.

i18n

i18n/
ย ย   โ”œโ”€โ”€ en-us.toml
 ย ย  โ””โ”€โ”€ ...

i18n holds Bissetii’s i18n translation dictionaries as Hugo theme module.

This directory must be compatible for:

  1. Hugo Theme (i18n/).

images

bissetii/
โ””โ”€โ”€ images/
 ย ย  โ”œโ”€โ”€ screenshot.png
 ย ย  โ””โ”€โ”€ tn.png

Required Hugo Theme directory for dislaying screenshot and thumbnail on Hugo’s theme store. You should not include anything else aside both of the listed files above.

layouts

layouts/
โ”œโ”€โ”€ 404.html
โ”œโ”€โ”€ _default/
โ”‚ย ย  โ”œโ”€โ”€ baseof.html
โ”‚ย ย  โ””โ”€โ”€ ...
โ”œโ”€โ”€ partials/
โ”‚ย ย  โ”œโ”€โ”€ amp/
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
โ”‚ย ย  โ”œโ”€โ”€ hugo-only/
โ”‚   โ”‚ย ย  โ”œโ”€โ”€ css/
โ”‚   โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
โ”‚   โ”‚ย ย  โ”œโ”€โ”€ js/
โ”‚   โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
โ”‚ย ย  โ”‚
โ”‚ย ย  โ”œโ”€โ”€ footers/
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
โ”‚ย ย  โ”œโ”€โ”€ .../
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
โ”‚ย ย  โ””โ”€โ”€ svg/
โ”‚ย ย   ย ย  โ””โ”€โ”€ ...
โ””โ”€โ”€ shortcodes/
    โ”œโ”€โ”€ absLangLink.html
    โ”œโ”€โ”€ ...
    โ””โ”€โ”€ sponsors/
 ย ย   ย ย  โ”œโ”€โ”€ PayPalME.html
        โ””โ”€โ”€ ...

layouts directory holds various partial templates and some Hugo-specific components.

There is one particular directory should be taken with extreme care: layouts/partials. This directory (with exception to layouts/partials/hugo-only) must be compatible for:

  1. Hugo theme.
  2. Go template imports.

The rest of the directories and files are only compatible for:

  1. Hugo themes (layouts/).

release

release/
ย ย  โ””โ”€โ”€ ...

release directory is a reserved directoy for the repository to deposit all the compiled packages. Hence, nothing should inherit this working directory.

.scripts

.scripts/
 ย ย  โ””โ”€โ”€ ...

scripts holds the Bissetii repository’s scripts for automated executions. These are normally package builder and manager, tester, and other operational scripts.

.sites

.sites/
โ”œโ”€โ”€ archetypes/
โ”‚ย ย  โ””โ”€โ”€ ...
โ”œโ”€โ”€ config/
โ”‚ย ย  โ””โ”€โ”€ _default/
โ”‚ย ย      โ”œโ”€โ”€ config.toml
โ”‚ย ย      โ””โ”€โ”€ ...
โ”œโ”€โ”€ ...
โ”œโ”€โ”€ resources/
โ”‚ย ย  โ””โ”€โ”€ ...
โ”œโ”€โ”€ static/
โ”‚ย ย  โ””โ”€โ”€ ...
โ””โ”€โ”€ themes/
ย ย   โ”œโ”€โ”€ bissetii/
    โ”‚ย ย   โ””โ”€โ”€ config.toml
 ย ย  โ””โ”€โ”€ ...

Bissetii local Hugo engine. This engine has several functions:

  1. Works as a local Hugo development point.
  2. Works as Bissetti website contents generator.
  3. Hosts release pacakges in its local static/releases directory.

This directory must be compatible for:

  1. Hugo themes (static/).

static

static/
โ”œโ”€โ”€ android-icon-144x144.png
โ”œโ”€โ”€ css/
โ”‚ย ย  โ”œโ”€โ”€ ...
โ”‚ย ย  โ””โ”€โ”€ fonts/
โ”‚ย ย   ย ย  โ””โ”€โ”€ ...
โ”œโ”€โ”€ img/
โ”‚ย ย  โ”œโ”€โ”€ logo/
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ 2500x1250-color.png
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ ...
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ s2048-color.svg
โ”‚ย ย  โ””โ”€โ”€ sponsors/
โ”‚ย ย      โ”œโ”€โ”€ any.jpg
โ”‚ย ย      โ”œโ”€โ”€ ...
โ”‚ย ย      โ””โ”€โ”€ meal.jpg
โ””โ”€โ”€ ...

static holds all the static files to be loaded directly into the server via Bissetii’s theme module.

This directory must be compatible for:

  1. Hugo themes (static/).
  2. Go Programming Language.

tests

tests/
 ย ย  โ”œโ”€โ”€ scripts/
 ย ย  โ”‚ย ย  โ””โ”€โ”€ ...
 ย ย  โ””โ”€โ”€ temp/
 ย ย   ย ย  โ””โ”€โ”€ ...

Bissetii’s local BaSHELL test framework for testing bash scripts or other automation work in the repository.

tmp

tmp/
 ย ย  โ””โ”€โ”€ ...

tmp directory is a reserved directory for the repository to perform automated operations. Hence, nothing should inherit this working directory.