Skip to content

Commit a4de141

Browse files
russfeldrussfeld
committed
Bump Theme 5.18
1 parent ab9911b commit a4de141

File tree

22 files changed

+247
-75
lines changed

22 files changed

+247
-75
lines changed

‎.github/dependabot.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
updates:
3+
# Maintain dependencies for GitHub Actions
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
interval: "daily"
8+
# Git Submosuldes
9+
- package-ecosystem: "gitsubmodule"
10+
directory: "/"
11+
schedule:
12+
interval: "daily"

‎.github/workflows/gh-pages.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# https://github.com/peaceiris/actions-hugo
2+
3+
name: GitHub Pages
4+
5+
on:
6+
push:
7+
branches:
8+
- master # Set a branch to deploy
9+
pull_request:
10+
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-20.04
14+
concurrency:
15+
group: ${{ github.workflow }}-${{ github.ref }}
16+
steps:
17+
- uses: actions/checkout@v3
18+
with:
19+
submodules: true # Fetch Hugo themes (true OR recursive)
20+
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
21+
22+
- name: Setup Hugo
23+
uses: peaceiris/actions-hugo@v2
24+
with:
25+
hugo-version: '0.117.0'
26+
# extended: true
27+
28+
- name: Build
29+
run: hugo -b "https://ksu-cs-textbooks.github.io/cis642-643/"
30+
31+
- name: Deploy
32+
uses: peaceiris/actions-gh-pages@v3
33+
if: ${{ github.ref == 'refs/heads/master' }}
34+
with:
35+
github_token: ${{ secrets.GITHUB_TOKEN }}
36+
publish_dir: ./public

‎.gitlab-ci.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# image: docker:20.10.11
2+
3+
# variables:
4+
# # When using dind service, you must instruct docker to talk with the
5+
# # daemon started inside of the service. The daemon is available with
6+
# # a network connection instead of the default /var/run/docker.sock socket.
7+
# #
8+
# # The 'docker' hostname is the alias of the service container as described at
9+
# # https://docs.gitlab.com/ee/ci/docker/using_docker_images.html#accessing-the-services
10+
# #
11+
# # If you're using GitLab Runner 12.7 or earlier with the Kubernetes executor and Kubernetes 1.6 or earlier,
12+
# # the variable must be set to tcp://localhost:2375 because of how the
13+
# # Kubernetes executor connects services to the job container
14+
# # DOCKER_HOST: tcp://localhost:2375
15+
# #
16+
# DOCKER_HOST: tcp://docker:2375
17+
# #
18+
# # This instructs Docker not to start over TLS.
19+
# DOCKER_TLS_CERTDIR: ""
20+
# #
21+
# # Checkout submodules recursively
22+
# GIT_SUBMODULE_STRATEGY: recursive
23+
24+
# services:
25+
# - docker:20.10.11-dind
26+
27+
# before_script:
28+
# - docker info
29+
# - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
30+
31+
# build-latest:
32+
# stage: build
33+
# only:
34+
# - tags
35+
# script:
36+
# - docker pull $CI_REGISTRY_IMAGE:latest || true
37+
# - docker build --cache-from $CI_REGISTRY_IMAGE:latest --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA --tag $CI_REGISTRY_IMAGE:latest .
38+
# - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
39+
# - docker push $CI_REGISTRY_IMAGE:latest
40+
41+
# build-branches:
42+
# stage: build
43+
# except:
44+
# - master
45+
# - main
46+
# script:
47+
# - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_BRANCH || true
48+
# - docker build --cache-from $CI_REGISTRY_IMAGE:latest --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_BRANCH .
49+
# - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
50+
# - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_BRANCH

‎.vscode/settings.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
"anonymized",
44
"maintainence",
55
"Similarily"
6-
]
6+
],
7+
"explorer.sortOrder": "mixed"
78
}

‎Dockerfile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
FROM nginx:alpine as build
2+
3+
RUN apk add --update \
4+
wget
5+
6+
ARG HUGO_VERSION="0.117.0"
7+
RUN wget --quiet "https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_${HUGO_VERSION}_Linux-64bit.tar.gz" && \
8+
tar xzf hugo_${HUGO_VERSION}_Linux-64bit.tar.gz && \
9+
rm -r hugo_${HUGO_VERSION}_Linux-64bit.tar.gz && \
10+
mv hugo /usr/bin
11+
12+
COPY ./ /site
13+
WORKDIR /site
14+
RUN hugo -b https://cis642-643.textbooks.cs.ksu.edu/
15+
16+
#Copy static files to Nginx
17+
FROM nginx:alpine
18+
COPY --from=build /site/public /usr/share/nginx/html
19+
20+
WORKDIR /usr/share/nginx/html

‎config.toml‎

Lines changed: 86 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,117 @@
1+
# Base URL where the site will be hosted
12
baseURL = "https://textbooks.cs.ksu.edu/cis642-643"
3+
# Default language for the site
24
languageCode = "en-us"
5+
# Site Title
36
title = "K-State CIS 642/643 Textbook"
7+
# This will fix URLs to match baseURL (for hosting in subfolders)
48
canonifyURLs = true
9+
# This displays last edited information at bottom of page
510
enableGitInfo = true
611

712
# Change the default theme to be use when building the site with Hugo
8-
theme = ["hugo-theme-relearn"]
13+
theme = "hugo-theme-relearn"
914

10-
# For search functionality
15+
# Output Types
16+
# HTML - default page
17+
# RSS - for RSS feeds
18+
# PRINT - printable output
19+
# JSON - enables Lunr search engine
20+
# TELE - Teleprompter
21+
# EMBED - Embeddable Version
1122
[outputs]
12-
home = ["HTML", "RSS", "PRINT", "JSON"]
23+
home = ["HTML", "RSS", "PRINT", "SEARCH", "SEARCHPAGE"]
1324
section = ["HTML", "RSS", "PRINT", "TELE", "EMBED"]
1425
page = ["HTML", "RSS", "PRINT", "TELE", "EMBED"]
1526

1627
[params]
28+
# This controls whether submenus will be expanded (true), or collapsed (false) in the
29+
# menu; if no setting is given, the first menu level is set to false, all others to true;
30+
# this can be overridden in the pages frontmatter
1731
alwaysopen = false
18-
textbookURL = "https://textbooks.cs.ksu.edu/cis642-643"
19-
editURL = "https://gitlab.cs.ksu.edu/nhbean/ksucs-hugo/tree/master/cis642-643-textbook/"
32+
# Prefix URL to edit current page. Will display an "Edit" button on top right hand corner of every page.
33+
# Useful to give opportunity to people to create merge request for your doc.
34+
# See the config.toml file from this documentation site to have an example.
35+
editURL = "https://gitlab.cs.ksu.edu/-/ide/project/cs-textbooks/cis642-643-textbook/edit/master/-/content/"
36+
# Author of the site, will be used in meta information
2037
author = "Nathan Bean"
38+
# Description of the site, will be used in meta information
2139
description = "K-State CIS 642/643 Textbook"
40+
# Shows a checkmark for visited pages on the menu
2241
showVisitedLinks = false
23-
disableSearch = false
24-
disableSeoHiddenPages = true
42+
# Disable search function. It will hide search bar
43+
disableSearch = false
44+
# Disable search in hidden pages, otherwise they will be shown in search box
45+
disableSearchHiddenPages = true
46+
# Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines
47+
disableSeoHiddenPages = true
48+
# Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden
2549
disableTagHiddenPages = true
26-
disableAssetBusting = true
27-
disableInlineCopyToClipboard = true
28-
disableShortcutsTitle = false
29-
disableLandingPageButton = true
50+
# Javascript and CSS cache are automatically busted when new version of site is generated.
51+
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
52+
disableAssetsBusting = false
53+
# Set this to true to disable copy-to-clipboard button for inline code.
54+
disableInlineCopyToClipBoard = true
55+
# A title for shortcuts in menu is set by default. Set this to true to disable it.
56+
disableShortcutsTitle = false
57+
# If set to false, a Home button will appear below the search bar on the menu.
58+
# It is redirecting to the landing page of the current language if specified. (Default is "/")
59+
disableLandingPageButton = true
60+
# When using mulitlingual website, disable the switch language button.
3061
disableLanguageSwitchingButton = false
31-
disableBreadcrumbs = false
32-
disableToc = false
33-
disableMathJax = true
34-
disableMermaid = true
35-
disableSwagger = true
36-
disableNextPrev = false
37-
themeVariant = ["light-theme", "dark-theme"]
38-
collapsibleMenu = true
39-
additionalContentLanguage = ["en"]
62+
# Hide breadcrumbs in the header and only show the current page title
63+
disableBreadcrumb = false
64+
# If set to true, hide table of contents menu in the header of all pages
65+
disableToc = false
66+
# If set to false, load the MathJax module on every page regardless if a MathJax shortcode is present
67+
disableMathJax = true
68+
# Specifies the remote location of the MathJax js
69+
# customMathJaxURL = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
70+
# Initialization parameter for MathJax, see MathJax documentation
71+
# mathJaxInitialize = "{}"
72+
# If set to false, load the Mermaid module on every page regardless if a Mermaid shortcode or Mermaid codefence is present
73+
disableMermaid = true
74+
# Specifies the remote location of the Mermaid js
75+
# customMermaidURL = "https://unpkg.com/mermaid/dist/mermaid.min.js"
76+
# Initialization parameter for Mermaid, see Mermaid documentation
77+
# mermaidInitialize = "{ \"theme\": \"default\" }"
78+
# If set to false, load the Swagger module on every page regardless if a Swagger shortcode is present
79+
disableSwagger = true
80+
# Specifies the remote location of the RapiDoc js
81+
# customSwaggerURL = "https://unpkg.com/rapidoc/dist/rapidoc-min.js"
82+
# Initialization parameter for Swagger, see RapiDoc documentation
83+
# swaggerInitialize = "{ \"theme\": \"light\" }"
84+
# Hide Next and Previous page buttons normally displayed full height beside content
85+
disableNextPrev = false
86+
# Order sections in menu by "weight" or "title". Default to "weight";
87+
# this can be overridden in the pages frontmatter
88+
ordersectionsby = "weight"
89+
# Change default color scheme with a variant one. Eg. can be "red", "blue", "green" or an array like [ "blue", "green" ].
90+
themeVariant = ["auto", "light-theme", "dark-theme"]
91+
# The first element is the variant for light mode, the second for dark mode
92+
themeVariantAuto = ["light-theme", "dark-theme"]
93+
# Change the title separator. Default to "::".
94+
# titleSeparator = "-"
95+
# If set to true, the menu in the sidebar will be displayed in a collapsible tree view.
96+
collapsibleMenu = true
97+
# If a single page can contain content in multiple languages, add those here
98+
additionalContentLanguage = [ "en" ]
4099

41-
#landingPageURL = "/cis642-643"
42-
#textbookURL = "https://textbooks.cs.ksu.edu/cis642-643"
43-
44-
linenumbers = true
45-
46-
[blackfriday]
47-
plainIDAnchors = true
48-
hrefTargetBlank = true
100+
# [x] russfeld
101+
# Custom parameters
102+
commitURL = "https://gitlab.cs.ksu.edu/cs-textbooks/cis642-643-textbook/-/commit/"
49103

50104
[markup]
51105
[markup.highlight]
52106
# if set to `guessSyntax = true`, there will be no unstyled code even if no language
53107
# was given BUT mermaid code fences will not work anymore! So this is a mandatory
54108
# setting for your site
55109
guessSyntax = false
110+
111+
# choose a color theme or create your own
56112
style = "monokai"
57113
[markup.goldmark]
58114
[markup.goldmark.renderer]
115+
# Render raw HTML
59116
unsafe = true
117+

‎content/00-forward/04-textbooks.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ date: 2018-08-24T10:53:26-05:00
99
This textbook was authored for the **CIS 642/643 - Software Engineering Project I&II** course at Kansas State University. This front matter is specific to that course. If you are not enrolled in the course, please disregard this section.
1010
{{% /notice %}}
1111

12-
This course does not have a required print textbook. The resources presented in the modules are also organized into an online textbook that can be accessed here: [{{< param textbookURL >}}]({{< param textbookURL >}}). You may find this a useful reference if you prefer a traditional textbook layout. Additionally, since the textbook exists outside of Canvas' access control, you can continue to utilize it after the course ends.
12+
This course does not have a required print textbook. The resources presented in the modules are also organized into an online textbook that can be accessed here: [{{< ref "/" >}}]({{< ref "/" >}}). You may find this a useful reference if you prefer a traditional textbook layout. Additionally, since the textbook exists outside of Canvas' access control, you can continue to utilize it after the course ends.
1313

1414
{{% notice warning %}}
1515
Please note that the materials presented in Canvas have additional graded assignments and exercises worked into the reading order that do not appear in the online edition of the textbook. You are responsible for completing these!

‎content/00-forward/07-642-syllabus/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,4 +161,4 @@ The details in this document are not set in stone – there may need to be adjus
161161
## Copyright Notice
162162
©2021 The materials in this online course fall under the protection of all intellectual property, copyright and trademark laws of the U.S. The digital materials included here come with the legal permissions and releases of the copyright holders. These course materials should be used for educational purposes only; the contents should not be distributed electronically or otherwise beyond the confines of this online course. The URLs listed here do not suggest endorsement of either the site owners or the contents found at the sites. Likewise, mentioned brands (products and services) do not suggest endorsement. Students own copyright to what they create.
163163

164-
Original content in the course textbook at [{{< param textbookURL >}}]({{< param textbookURL >}}) is licensed under a Creative Commons BY-SA license by Nathan Bean unless otherwise stated.
164+
Original content in the course textbook at [{{< ref "/" >}}]({{< ref "/" >}}) is licensed under a Creative Commons BY-SA license by Nathan Bean unless otherwise stated.

‎content/00-forward/07-642-syllabus/old/fall-2021.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,4 +156,4 @@ The details in this document are not set in stone – there may need to be adjus
156156
## Copyright Notice
157157
©2021 The materials in this online course fall under the protection of all intellectual property, copyright and trademark laws of the U.S. The digital materials included here come with the legal permissions and releases of the copyright holders. These course materials should be used for educational purposes only; the contents should not be distributed electronically or otherwise beyond the confines of this online course. The URLs listed here do not suggest endorsement of either the site owners or the contents found at the sites. Likewise, mentioned brands (products and services) do not suggest endorsement. Students own copyright to what they create.
158158

159-
Original content in the course textbook at [{{< param textbookURL >}}]({{< param textbookURL >}}) is licensed under a Creative Commons BY-SA license by Nathan Bean unless otherwise stated.
159+
Original content in the course textbook at [{{< ref "/" >}}]({{< ref "/" >}}) is licensed under a Creative Commons BY-SA license by Nathan Bean unless otherwise stated.

‎content/00-forward/08-643-syllabus.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,4 +143,4 @@ The details in this document are not set in stone – there may need to be adjus
143143
## Copyright Notice
144144
©2021 The materials in this online course fall under the protection of all intellectual property, copyright and trademark laws of the U.S. The digital materials included here come with the legal permissions and releases of the copyright holders. These course materials should be used for educational purposes only; the contents should not be distributed electronically or otherwise beyond the confines of this online course. The URLs listed here do not suggest endorsement of either the site owners or the contents found at the sites. Likewise, mentioned brands (products and services) do not suggest endorsement. Students own copyright to what they create.
145145

146-
Original content in the course textbook at [{{< param textbookURL >}}]({{< param textbookURL >}}) is licensed under a Creative Commons BY-SA license by Nathan Bean unless otherwise stated.
146+
Original content in the course textbook at [{{< ref "/" >}}]({{< ref "/" >}}) is licensed under a Creative Commons BY-SA license by Nathan Bean unless otherwise stated.

0 commit comments

Comments
 (0)