Skip to content

Commit

Permalink
STW: Move theme to main repo (htw-imi-showtime#378)
Browse files Browse the repository at this point in the history
* copy showtime-theme-2021 to showtime-theme-2024 - commit 20b1090e41e42f6cf27fcabd52f19281fb43befd tag: last_version_as_submodule

* config new theme, delete old theme folder

* remove get theme from gh actions

* remove theme from readme

* add old theme to gitignore

* remove deploy-production-without-archive.yml
  • Loading branch information
bkleinen committed Jul 16, 2024
1 parent e238bf9 commit 335e26c
Show file tree
Hide file tree
Showing 77 changed files with 3,171 additions and 81 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/check-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ jobs:
- uses: actions/checkout@v4
with:
submodules: false
- name: Get Theme
run: |
git submodule update --init themes/showtime-theme-2021

- name: Hugo setup
uses: peaceiris/actions-hugo@v3
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/deploy-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ jobs:
with:
submodules: true


- name: Hugo setup
uses: peaceiris/actions-hugo@v3
with:
Expand Down
37 changes: 0 additions & 37 deletions .github/workflows/deploy-production-without-archive.yml

This file was deleted.

3 changes: 0 additions & 3 deletions .github/workflows/deploy-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ jobs:
- uses: actions/checkout@v4
with:
submodules: false
- name: Get Theme
run: |
git submodule update --init themes/showtime-theme-2021

- name: Hugo setup
uses: peaceiris/actions-hugo@v3
Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/deploy-tryout.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ jobs:
- uses: actions/checkout@v4
with:
submodules: false
- name: Get Theme
run: |
git submodule update --init themes/showtime-theme-2021

- name: Hugo setup
uses: peaceiris/actions-hugo@v3
with:
Expand Down
3 changes: 0 additions & 3 deletions .github/workflows/deploy_pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ jobs:
- uses: actions/checkout@v4
with:
submodules: false
- name: Get Theme
run: |
git submodule update --init themes/showtime-theme-2021

- name: Hugo setup
uses: peaceiris/actions-hugo@v3
Expand Down
8 changes: 2 additions & 6 deletions .github/workflows/gh-pages-action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,8 @@ jobs:
- uses: actions/checkout@v4
with:
submodules: false
fetch-depth: 1 # Fetch all history for .GitInfo and .Lastmod

- name: Get Theme
run: |
git submodule update --init themes/showtime-theme-2021
fetch-depth: 1

- name: Setup Hugo
uses: peaceiris/actions-hugo@v3
with:
Expand Down
6 changes: 1 addition & 5 deletions .github/workflows/gh-pages-branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,7 @@ jobs:
- uses: actions/checkout@v4
with:
submodules: false
fetch-depth: 1 # Fetch all history for .GitInfo and .Lastmod

- name: Get Theme
run: |
git submodule update --init themes/showtime-theme-2021
fetch-depth: 1

# see https://github.com/marketplace/actions/hugo-setup
- name: Setup Hugo
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ hugo-temp/
tmp/
files-other.txt
files-project.txt
themes/showtime-theme-2021/
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,28 +71,21 @@ If you want to add your project to the website, please follow these steps and cr
2. Clone the project:

2.a Without archive submodule:
```
git clone --depth 1 https://github.com/<your-account>/showtime-website.git
cd showtime-website
```
or using SSH:

```
git clone --depth 1 [email protected]:<your-account>/showtime-website.git
cd showtime-website
```

then get the theme submodule:
you can always get the archive later by running:
(currently about 1,3G)

```
git submodule update --init themes/showtime-theme-2021
git submodule update --init project-archive
```

2.b Complete with both submodules:
```
git clone --depth 1 --recurse-submodules https://github.com/<your-account>/showtime-website.git
cd showtime-website
```
or using SSH:
2.b Complete with archive submodules:

```
git clone --depth 1 --recurse-submodules [email protected]:<your-account>/showtime-website.git
cd showtime-website
Expand All @@ -101,13 +94,22 @@ cd showtime-website
3. [Install Hugo (extended)](https://gohugo.io/getting-started/installing) from https://gohugo.io \
You can check your installation by executing `hugo server` and visiting
http://localhost:1313/ in your browser.


If you get an error:
* Did you forget to clone the submodules? If so, you can get the theme submodule by running
```
git submodule update --init themes/showtime-theme-2021
```

* Did you install the Hugo extended version? This is needed for Hugo to correctly compile the theme's SCSS files

4. Create a branch

As we are using the forking workflow on the showtime website, never change main directly, but keep it synced with the
main repository. Always work in branches. After your changes have been merged with a pull request, discard the branch,
update main (get your merged changes squashed into one commit) and create a new branch from there.

```
git checkout -b b0_first_version_of_our_project_site_or_anything_else_you_fancy_as_a_branch_name
```

4. Create a new project directory for your project by duplicating either the bachelor's or the master's sample project directory:
```
Expand All @@ -116,7 +118,11 @@ cp -R content/ws23/bachelor/b0-template/ content/ws23/bachelor/b#-your-project/
```
cp -R content/ws23/master/m0-template/ content/ws23/master/m#-your-project/
```
**Please make sure to include your project number! (e.g. B2, M1, ...)**

**Please make sure to include your project number! (e.g. b2, m1, ...)**

File names need to be all lower case, WITHOUT SPACES and no special characters except - and _ .
see [bin/check-project-update-pr/check-file-names.sh](bin/check-project-update-pr/check-file-names.sh)

5. Fill out your project's homepage `content/ss24/<bachelor/master>/##-your-project/_index.md` and any subpages in your project's directory you'd like to keep. Delete the subpages you don't need.\

Expand Down Expand Up @@ -145,7 +151,6 @@ I've started a documentation on how we should use the forking workflow here:
[https://github.com/htw-imi-showtime/showtime-website/blob/documentation/doc/forking-workflow/index.md](https://github.com/htw-imi-showtime/showtime-website/blob/documentation/doc/forking-workflow/index.md)
(will not be merged to main due to file sizes)


## Deploy your Fork on GH-Pages


Expand Down
2 changes: 1 addition & 1 deletion config/_default/config.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
baseURL = "http://localhost:1313/"
languageCode = "de-de"
title = "IMI Showtime"
theme = "showtime-theme-2021"
theme = "showtime-theme-2024"
enableGitInfo = true

[params]
Expand Down
1 change: 0 additions & 1 deletion themes/showtime-theme-2021
Submodule showtime-theme-2021 deleted from 20b109
2 changes: 2 additions & 0 deletions themes/showtime-theme-2024/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.DS_Store
Thumbs.db
6 changes: 6 additions & 0 deletions themes/showtime-theme-2024/NOTES.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## Thursday, 13.June 2024 12:33

blocks are not supported within partials, see
https://github.com/gohugoio/hugo/issues/7936

-> include header and footer in baseof.html
28 changes: 28 additions & 0 deletions themes/showtime-theme-2024/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Showtime Hugo Theme
The new 2021 Hugo showtime theme!

## Structure

### `archetypes/`
Contains templates for generating new pages using the Hugo CLI.

### `assets/`
The assets folder contains files that should be processed by Hugo before being served. This includes assets like SCSS.

### `layouts/`
The layouts folder contains the HTML templates for this theme.
* `index.html` - Contains the home page's layout
* `_default/`
* `baseof.html` - Contains the base structure of the site which should be always applied
* `list.html` - Contains the layout for the index pages of the different sections (e.g. ss20, ...)
* `project.html` - Contains the layout for the project pages
* `projects-list.html` - Contains the layout for the projects list for the current semester
* `single.html` - Contains the layout for all single pages, like the imprint
* `partials/` - Contains partial templates to be included/reused in other templates for this theme
* `shortcodes/` - Contains partials which can be included in markdown pages

### `static/`
The static folder contains files that should be served without being processed by Hugo. You may put files like images, CSS or scripts into this folder.

### `theme.toml`
Contains metadata about the theme (e.g. theme name, author, description)
2 changes: 2 additions & 0 deletions themes/showtime-theme-2024/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
+++
+++
11 changes: 11 additions & 0 deletions themes/showtime-theme-2024/assets/sass/_colors.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
$color-primary: #ff7578;
$color-accent: #fdfe83;
$color-link: #29d09f;
$color-dark: #3e2d4a;

$color-background: #fff6f6;
$color-secondary: #ff927a;
$color-link-dark: #0ad0a1;

$color-dropdown: #67ffd2;
$color-button-active: #1CA37B;
Loading

0 comments on commit 335e26c

Please sign in to comment.