Skip to content

Rework hugo.toml file. #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions config/_default/hugo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# *******************************************************************
#
# Hugo parameters for Interlisp.org
#
# An overview of hugo configuration files can be found at:
# https://gohugo.io/getting-started/configuration/#configure-server
#

# relativeURLs: Enable to force all relative URLs to be relative to content root
relativeURLs: false

# canonifyURLs: Convert relative URLs to absolute URLs
canonifyURLs: true

# enableRobotsTXT: Enable generation of Robots.txt file
enableRobotsTXT: true

# aasetDir: Location where Hugo looks for assets
assetDir: static

# Enable .GitInfo object for each page. This will give values to .Lastmod etc.
enableGitInfo: false

# Top Level Language defaults
# See languages.yaml for language specific values
defaultContentLanguage: "en"
defaultContentLanguageInSubdir: false

# Useful when translating.
enableMissingTranslationPlaceholders: true

# Disable rendering of the specified page kinds
disableKinds:
- taxonomy
- term
- RSS

# Code Highlighting configuration
# Not Used. Code highlighting is controlled using the highlighting
# section in `markup.yaml`
#pygmentsCodeFences: false
#pygmentsUseClasses: false
# Use the new Chroma Go highlighter in Hugo.
# pygmentsUseClassic: false
# pygmentsOptions: linenos=table
# See https://help.farbox.com/pygments.html

# Comment out if you don't want the "print entire section" link enabled.
# [outputs]
# section = ["HTML", "print"]
9 changes: 9 additions & 0 deletions config/_default/imaging.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# ****************************************************************************
#
# Image processing setup
#
# Configuration information available at:
# https://gohugo.io/content-management/image-processing/#resampling-filter
resampleFilter: CatmullRom
quality: 75
anchor: smart
13 changes: 13 additions & 0 deletions config/_default/languages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# ****************************************************************************
#
# Language configuration
#
# See: https://gohugo.io/content-management/multilingual/
#
en:
languageName: English"
# Weight used for sorting.
weight: 1
contentDir: content/en
params:
description: "Dedicated to restoring and preserving the Interlisp experience"
29 changes: 29 additions & 0 deletions config/_default/markup.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ****************************************************************************
#
# Goldmark markdown processor setup
#
# See: https://gohugo.io/getting-started/configuration-markup/#goldmark
# for additional configuration options
#
goldmark:
renderer:
unsafe: true
#
# Code block processing
#
# See: https://gohugo.io/getting-started/configuration-markup/#highlight
# for additional information on configuration options.
# https://www.docsy.dev/docs/adding-content/lookandfeel/#code-highlighting-with-chroma
# contains Docsy specfiic code highlighting information
highlight:
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
#style: solarized-dark
style: tango
codeFences: true
noClasses: true
hl_inline: false
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
guessSyntax: true
tabWidth: 4
#lineNoStart: 1
lineNos: false
25 changes: 25 additions & 0 deletions config/_default/menu.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# ****************************************************************************
#
# Hugo - Top-level navigation (horizontal)
#
main:
- name: GitHub
weight: -10
pre: <i class='fab fa-github'></i>
url: https://github.com/interlisp
- name: Get Involved
weight: -30
pre: <i class='fas fa-handshake-simple'></i>
url: /getInvolved/
- name: Software
weight: -50
pre: <i class='fas fa-cube'></i>
url: /software/
- name: Project
weight: -70
pre: <i class='fas fa-globe'></i>
url: /project/
- name: History
weight: -90
pre: "<i class='fas fa-book'></i>"
url: /history/
11 changes: 11 additions & 0 deletions config/_default/module.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
proxy: "direct"
# uncomment line below for temporary local development of module
# replacements = "github.com/google/docsy -> ../../docsy"
hugoVersion:
extended: true
min: "0.73.0"
imports:
- path: "github.com/google/docsy"
disable: false
- path: "github.com/google/docsy/dependencies"
disable: false
154 changes: 154 additions & 0 deletions config/_default/params.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
# --------------------------------------------------------------------
#
# Parameters
#

# Set Google Analytics to use GA4
disableGtagForUniversalAnalytics: false

# First one is picked as the Twitter card image if not set on page.
# images = ["images/project-illustration.png"]

# Menu title if your navbar has a versions selector to access old versions of your site.
# This menu appears only if you have at least one [params.versions] set.
version_menu: Releases

# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version: false

# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
version: 0.0

# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version: https://example.com

# Enable syntax highlighting and copy buttons on code blocks with Prism
# We are using code highlighting via Chroma. Chroma options are defined
# in `markup.yaml`
prism_syntax_highlighting: false

# copyright: site copyright information
# authors: text list of authors
# from_year: year in copyright statement
#
copyright:
authors: Interlisp.org
from_year: 2024
license: MIT

# github information
# github_repo: url to repo of web site
# github_branch: main branch of repo
# github_subdir: unused by Interlisp.org
# github_project_repo: added by Interlisp.org points to repo used
# for issue reporting
#
github_repo: https://github.com/interlisp/Interlisp.github.io
github_branch: main
github_subdir:
github_project_repo: https://github.com/interlisp/medley

# Google custom seach engine configuration
# gcs_engine_id: search engine
gcs_engine_id: 33ef4cbe0703b4f3a

# Footer Links
#
# user: End user relevant links. These will show up on
# left side of footer and in the community page if you have one.
# name: displayed when moused over
# url: url to use when selected
# desc: description
# icon: icon to display
links:
user:
- name: "User mailing list"
url: "mailto:Interlisp@googlegroups.com"
icon: "fa fa-envelope"
desc: "Discussion and help from your fellow users"
- name: "Twitter"
url: "https://twitter.com/interlisp8"
icon: "fab fa-twitter"
desc: "Follow us on Twitter to get the latest news!"
# - name: "Stack Overflow"
# url: "https://stackoverflow.com/questions/tagged/graphviz"
# icon: "fab fa-stack-overflow"
# desc: "Practical questions and curated answers"

# developer: Developer relevant links. These will show up on right
# side of footer and in the community page if you have one.
developer:
- name: "On GitHub"
url: "https://github.com/interlisp"
icon: "fab fa-github"
desc: "Development takes place here!"
# - name: "Slack"
# url: "https://example.org/slack"
# icon: "fab fa-slack"
# desc: "Chat with other project developers"
# - name: "Developer mailing list"
# url: "https://example.org/mail"
# icon: "fa fa-envelope"
# desc: "Discuss development issues around the project"

taxonomies:
# Nothing defined

# User Interface Configuration options
#
# feedback:
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses
# are sent to Google Analytics as events. This feature depends
# on [services.googleAnalytics] and will be disabled if
# "services.googleAnalytics.id" is not set.
#
# If you want this feature, but occasionally need to remove the
# "Feedback" section from a single page,
# add "hide_feedback: true" to the page's front matter.
# enable: boolean Turn feedback
# yes: text to display with yes is selected
# no: text to display when no is selected

ui:
feedback:
enable: true
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>.'
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>.'

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea of per-page asking for feedback, but I havent seen any.
Is it how we're asking?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly - I really have no idea how much feedback other sites get from this type of setup.  

But, I can imagine that with longer documents you have an issue with users even getting to the feedback button.  If, the information isn't useful, they'll be long gone before they get to it.

# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# add "hide_readingtime: true" to the page's front matter
readingtime:
enable: false

# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
navbar_logo: true

# Turn off transparency in nav bar
navbar_translucent_over_cover_disable: true

# Enable to show the side bar menu in its compact state.
sidebar_menu_compact: true
sidebar_menu_foldable: true

# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable: false
# Sidebar generation is slow otherwise
sidebar_cache_limit: 100

# We have almost 200 attributes; don't truncate the sidebar to max 50 contents.
sidebar_menu_truncate: 1000

# Set to true to disable breadcrumb navigation.
breadcrumb_disable: false

# Set to true to disable the About link in the site footer
footer_about_disable: true

ul_show: 3

9 changes: 9 additions & 0 deletions config/_default/permalinks.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# --------------------------------------------------------------------
#
# Permalinks
#
# Define a URL pattern for each top-level section.
#
# see: https://gohugo.io/content-management/urls/#permalinks
#
blog: /:section/:year/:month/:day/:slug/
18 changes: 18 additions & 0 deletions config/_default/privacy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# ------------------------------------------------------------------
#
# Privacy Settings
#
# See: https://gohugo.io/about/hugo-and-gdpr/
#
# googleAnalytics:
# ananymizIP: Enable anonymiation of IP addresses
# disable: Set to true to disable googleAnalytics
# respectDoNotTrack: Check for Do Not Track in headers
# useSessionStorage: Store session information in storage and
# not in cookies
privacy:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what and where is our "privacy policy" and does everyone know?
What do we want to say about our non-promise of privacy when using online? (For diagnostic purposes etc)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is new to us -- it is one of the areas I noticed in poking around.  I took an initial cut at settings, but I'm open to suggestions. I would like someone that understand GDPR to weigh in and suggest any needed changes.

googleAnalytics:
anonymizeIP: true
disable: false
respectDoNotTrack: true
useSessionStorage: true
8 changes: 8 additions & 0 deletions config/development/server.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
headers:
- for: /**
values:
Content-Security-Policy: script-src localhost:1313
Referrer-Policy: strict-origin-when-cross-origin
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
X-XSS-Protection: 1; mode=block
1 change: 1 addition & 0 deletions config/production/hugo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
baseURL: https://interlisp.org
7 changes: 7 additions & 0 deletions config/production/services.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# ****************************************************************************
#
# Services Configuration
#
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
googleAnalytics:
id: G-JXK20KN1W1
4 changes: 4 additions & 0 deletions config/staging/hugo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
baseURL: https://wasm.interlisp.org
languageCode: en-us
title: 'Staging Environment'
publishDir: stage
Loading