Skip to content
Leon Kaucher edited this page May 17, 2019 · 3 revisions

This wiki documents how you can modify content and develop for the SmartAQnet Website.

The documentation is divided into two parts:

  • The Editor documentation describes how to modify/add content like posts, pages and entries in various components (calendar, navigation, ...).
  • The Developer documentation details how to modify/add components, change styles and program logic.

Directory structure

.
├── assets # static and source files
│   ├── data # liquid files for compiling the global site search database
│   ├── dist # output of gulp / Do not edit manually, will be overwritten
│   ├── src # sources to be compiled with gulp/jekyll
│   │   ├── css # Stylesheets to be compiled with Sass
│   │   └── js
│   │       └── partials # Javascript partials to be compiled into main.min.js
│   └── static # Static files (documents, images, ...)
│       ├── css
│       │   └── vendor # 3rd-party stylesheets
│       ├── downloads # Static files / documents downloadable through links
│       │   │── Newsletter
│       │   │   ├── de
│       │   │   └── en
│       │   └── ...
│       ├── fonts # fonts (KaTeX, Font Awesome, ...)
│       ├── icons # Favicons and styling manifests for OS Tiles / Bookmarks
│       ├── img # Images (Are compressed in-place with gulp)
│       │   ├── galleries # Image directories used in gallery pages
│       │   └── ...
│       └── js
│           └── vendor # 3rd-party script files
├── dashboard # Dashboard git submodule (https://github.com/SmartAQnet/dashboard/tree/embedded-dashboard)
├── _data # Liquid data used for page generation (e.g localized strings in components like the calendar)
│   ├── de
│   └── en
├── _drafts # Draft posts (currently not used)
├── _includes # Jekyll includes
├── _layouts # Jekyll layouts
├── pages # Preferred location for pages
│   ├── de
│   └── en
├── _posts # Required location for posts
│   ├── de
│   └── en
└── _sass # Theme generated at jekyll build
Clone this wiki locally