Project Structure

This page briefly explains the code structure of the current project to help getting started as well as help to find the places where changes are required.

Current project structure

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69


├── LICENSE
├── README.md
├── assets
│   ├── favicon.png
│   ├── icons
│   │   └── git.svg
│   ├── img
│   │   └── logo_2.png
│   └── scss
│       └── custom.scss
├── config
│   └── _default
│       ├── config.toml
│       ├── languages.toml
│       ├── markup.toml
│       ├── menu.toml
│       ├── module.toml
│       ├── params.toml
│       ├── permalinks.toml
│       └── related.toml
├── content
│   ├── _index.md
│   ├── barrierefreiheit
│   │   └── index.md
│   ├── categories
│   │   └── hugo
│   │       ├── _index.md
│   │       └── hugo-logo-wide.svg
│   ├── data-privacy
│   │   └── index.md
│   ├── page
│   │   ├── archives
│   │   │   ├── index.de.md
│   │   │   └── index.md
│   │   ├── links
│   │   │   └── index.md
│   │   └── search
│   │       ├── index.de.md
│   │       └── index.md
│   ├── post
│   │   ├── image-gallery
│   │   │   ├── 1.jpg
│   │   │   ├── 2.jpg
│   │   │   └── index.md
│   │   ├── introduction
│   │   │   ├── 2018_11_00_PanoramaMarburg1_Thorsten_Richter.jpg
│   │   │   ├── index.de.md
│   │   │   └── index.md
│   │   ├── project-structure
│   │   │   └── index.md
│   │   ├── shortcodes
│   │   │   ├── cover.jpg
│   │   │   ├── dummy.pdf
│   │   │   ├── index.md
│   │   │   └── movie.mp4
│   │   └── template-explanation
│   │       ├── index.de.md
│   │       └── index.md
│   └── tags
│       └── example-tag
│           └── _index.md
├── go.mod
├── go.sum
└── layouts
    └── partials
        └── footer
            ├── components
            │   └── custom-font.html
            └── footer.html

The project contains four main folders, assets, config, content, and layouts.

The assets folder contains the favicon, the logo shown on the top left corner, as well as the scss setting the languages. The config folder contains settings such as the language, the title for the different languages and the used modules (here: the stack theme and the pdf shortcode). The content contains the content of the pages, the main entries shown in the center of the page go in the post subfolder, each post has one subfolder, where the the index.md is written in the default language, other languages can be added by adding a file with the language code e.g., index.de.md. The page subfolder contains the sites shown in the navigation bar on the left of the page. Extra sites such as the data privacy get an extra subfolder. The description of tags and categories can be set in their respective subfolders The layouts folder is used to specify the footer and remove Google Fonts from being used to respect the data privacy of the website visitors.