Skip to content

Commit 4f134bc

Browse files
committed
Rework hugo.toml file.
Convert to yaml and break into subsections. Move to config directory. Start setup to support Production and Staged deployments
1 parent 6742c18 commit 4f134bc

File tree

12 files changed

+264
-280
lines changed

12 files changed

+264
-280
lines changed

config/_default/hugo.toml

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# *******************************************************************
2+
#
3+
# Hugo parameters for Interlisp.org
4+
#
5+
6+
relativeURLs = true
7+
canonifyURLs = true
8+
9+
enableRobotsTXT = true
10+
11+
assetDir = "static"
12+
13+
# ****************************************************************************
14+
#
15+
# Docsy
16+
#
17+
18+
# Will give values to .Lastmod etc.
19+
# enableGitInfo = true
20+
21+
# Language settings
22+
defaultContentLanguage = "en"
23+
defaultContentLanguageInSubdir = false
24+
25+
# Useful when translating.
26+
enableMissingTranslationPlaceholders = true
27+
28+
disableKinds = ["taxonomy", "taxonomyTerm", "RSS"]
29+
30+
# Highlighting config
31+
pygmentsCodeFences = true
32+
pygmentsUseClasses = false
33+
# Use the new Chroma Go highlighter in Hugo.
34+
pygmentsUseClassic = false
35+
#pygmentsOptions = "linenos=table"
36+
# See https://help.farbox.com/pygments.html
37+
pygmentsStyle = "tango"
38+
39+
# Configure how URLs look like per section.
40+
[permalinks]
41+
blog = "/:section/:year/:month/:day/:slug/"
42+
43+
# ****************************************************************************
44+
#
45+
# Docsy - Everything below this are Site Params
46+
#
47+
48+
# Comment out if you don't want the "print entire section" link enabled.
49+
# [outputs]
50+
# section = ["HTML", "print"]
51+
52+
[params]
53+
54+
# privacy_policy = "https://policies.google.com/privacy"
55+
56+
# Set Google Analytics to use GA4
57+
disableGtagForUniversalAnalytics = false
58+
59+
60+
# First one is picked as the Twitter card image if not set on page.
61+
# images = ["images/project-illustration.png"]
62+
63+
# Menu title if your navbar has a versions selector to access old versions of your site.
64+
# This menu appears only if you have at least one [params.versions] set.
65+
version_menu = "Releases"
66+
67+
# Flag used in the "version-banner" partial to decide whether to display a
68+
# banner on every page indicating that this is an archived version of the docs.
69+
# Set this flag to "true" if you want to display the banner.
70+
archived_version = false
71+
72+
# The version number for the version of the docs represented in this doc set.
73+
# Used in the "version-banner" partial to display a version number for the
74+
# current doc set.
75+
version = "0.0"
76+
77+
# A link to latest version of the docs. Used in the "version-banner" partial to
78+
# point people to the main doc site.
79+
url_latest_version = "https://example.com"
80+
81+
# Enable Algolia DocSearch
82+
#algolia_docsearch = false
83+
84+
# Enable Lunr.js offline search
85+
# offlineSearch = true
86+
87+
# Enable syntax highlighting and copy buttons on code blocks with Prism
88+
# Default "Chroma" syntax highlighter has no dot support, so use Prism instead
89+
prism_syntax_highlighting = false
90+

config/_default/imaging.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ****************************************************************************
2+
#
3+
# Image processing setup
4+
#
5+
# Configuration information available at:
6+
# https://gohugo.io/content-management/image-processing/#resampling-filter
7+
resampleFilter: CatmullRom
8+
quality: 75
9+
anchor: smart

config/_default/languages.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ****************************************************************************
2+
#
3+
# Language configuration
4+
#
5+
en:
6+
description: "Dedicated to restoring and preserving the Interlisp experience"
7+
languageName: English"
8+
# Weight used for sorting.
9+
weight: 1
10+
contentDir: content/en

config/_default/markup.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ****************************************************************************
2+
#
3+
# Goldmark markdown processor setup
4+
#
5+
goldmark:
6+
renderer:
7+
unsafe: true
8+
highlight:
9+
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
10+
style: tango
11+
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
12+
# guessSyntax: true

config/_default/menu.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# ****************************************************************************
2+
#
3+
# Hugo - Top-level navigation (horizontal)
4+
#
5+
main:
6+
- name: GitHub
7+
weight: -10
8+
pre: <i class='fab fa-github'></i>
9+
url: https://github.com/interlisp
10+
- name: Get Involved
11+
weight: -30
12+
pre: <i class='fas fa-handshake-simple'></i>
13+
url: /getInvolved/
14+
- name: Software
15+
weight: -50
16+
pre: <i class='fas fa-cube'></i>
17+
url: /software/
18+
- name: Project
19+
weight: -70
20+
pre: <i class='fas fa-globe'></i>
21+
url: /project/
22+
- name: History
23+
weight: -90
24+
pre: "<i class='fas fa-book'></i>"
25+
url: /history/

config/_default/module.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
proxy: "direct"
2+
# uncomment line below for temporary local development of module
3+
# replacements = "github.com/google/docsy -> ../../docsy"
4+
hugoVersion:
5+
extended: true
6+
min: "0.73.0"
7+
imports:
8+
- path: "github.com/google/docsy"
9+
disable: false
10+
- path: "github.com/google/docsy/dependencies"
11+
disable: false

config/_default/params.yaml

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Parameters
2+
copyright:
3+
authors: Interlisp.org
4+
from_year: 2024
5+
6+
github_repo: https://github.com/interlisp/Interlisp.github.io
7+
github_branch: main
8+
github_project_repo: https://github.com/interlisp/medley
9+
github_subdir:
10+
gcs_engine_id: 33ef4cbe0703b4f3a
11+
12+
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
13+
links:
14+
user:
15+
- name: "User mailing list"
16+
url: "mailto:Interlisp@googlegroups.com"
17+
icon: "fa fa-envelope"
18+
desc: "Discussion and help from your fellow users"
19+
- name: "Twitter"
20+
url: "https://twitter.com/interlisp8"
21+
icon: "fab fa-twitter"
22+
desc: "Follow us on Twitter to get the latest news!"
23+
# - name: "Stack Overflow"
24+
# url: "https://stackoverflow.com/questions/tagged/graphviz"
25+
# icon: "fab fa-stack-overflow"
26+
# desc: "Practical questions and curated answers"
27+
28+
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
29+
developer:
30+
- name: "On GitHub"
31+
url: "https://github.com/interlisp"
32+
icon: "fab fa-github"
33+
desc: "Development takes place here!"
34+
# - name: "Slack"
35+
# url: "https://example.org/slack"
36+
# icon: "fab fa-slack"
37+
# desc: "Chat with other project developers"
38+
# - name: "Developer mailing list"
39+
# url: "https://example.org/mail"
40+
# icon: "fa fa-envelope"
41+
# desc: "Discuss development issues around the project"
42+
43+
taxonomy:
44+
# Nothing defined
45+
46+
# User Interface Configuration options
47+
ui:
48+
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
49+
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
50+
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
51+
# add "hide_feedback: true" to the page's front matter.
52+
feedback:
53+
enable: true
54+
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
55+
yes: 'Glad to hear it! Please <a href="https://github.com/Interlisp/medley/issues/new?template=documentation.md&projects=Interlisp/medley/5">tell us how we can improve</a>.'
56+
no: 'Sorry to hear that. Please <a href="https://github.com/Interlisp/medley/issues/new?template=documentation.md&projects=Interlisp/medley/5">tell us how we can improve</a>.'
57+
58+
# Adds a reading time to the top of each doc.
59+
# If you want this feature, but occasionally need to remove the Reading time from a single page,
60+
# add "hide_readingtime: true" to the page's front matter
61+
readingtime:
62+
enable: false
63+
64+
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
65+
navbar_logo: true
66+
67+
# Turn off transparency in nav bar
68+
navbar_translucent_over_cover_disable: true
69+
70+
# Enable to show the side bar menu in its compact state.
71+
sidebar_menu_compact: true
72+
sidebar_menu_foldable: true
73+
74+
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
75+
sidebar_search_disable: false
76+
# Set to true to disable breadcrumb navigation.
77+
breadcrumb_disable: false
78+
79+
# Set to true to disable the About link in the site footer
80+
footer_about_disable: true
81+
82+
ul_show: 3
83+
84+
# Sidebar generation is slow otherwise
85+
sidebar_cache_limit: 100
86+
87+
# We have almost 200 attributes; don't truncate the sidebar to max 50 contents.
88+
sidebar_menu_truncate: 1000

config/development/server.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
headers:
2+
- for: /**
3+
values:
4+
Content-Security-Policy: script-src localhost:1313
5+
Referrer-Policy: strict-origin-when-cross-origin
6+
X-Content-Type-Options: nosniff
7+
X-Frame-Options: DENY
8+
X-XSS-Protection: 1; mode=block

config/production/config.toml

Whitespace-only changes.

config/production/services.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# ****************************************************************************
2+
#
3+
# Services Configuration
4+
#
5+
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
6+
googleAnalytics:
7+
id: G-JXK20KN1W1

0 commit comments

Comments
 (0)