Skip to content

Commit c4c8eb1

Browse files
committed
Continued cleanup of config files
Code Highlighting cleaned up and better commented. Updated `software/install-and-run/windows/native/_index.md` to test and validate code block processing.
1 parent 4eabd13 commit c4c8eb1

File tree

5 files changed

+78
-63
lines changed

5 files changed

+78
-63
lines changed

config/_default/hugo.yaml

Lines changed: 11 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
#
88

99
# relativeURLs: Enable to force all relative URLs to be relative to content root
10-
relativeURLs: true
10+
relativeURLs: false
1111

1212
# canonifyURLs: Convert relative URLs to absolute URLs
1313
canonifyURLs: true
@@ -30,58 +30,21 @@ defaultContentLanguageInSubdir: false
3030
enableMissingTranslationPlaceholders: true
3131

3232
# Disable rendering of the specified page kinds
33-
disableKinds: [taxonomy, term, RSS]
33+
disableKinds:
34+
- taxonomy
35+
- term
36+
- RSS
3437

3538
# Code Highlighting configuration
36-
pygmentsCodeFences: true
37-
pygmentsUseClasses: false
39+
# Not Used. Code highlighting is controlled using the highlighting
40+
# section in `markup.yaml`
41+
#pygmentsCodeFences: false
42+
#pygmentsUseClasses: false
3843
# Use the new Chroma Go highlighter in Hugo.
39-
pygmentsUseClassic: false
40-
#pygmentsOptions = "linenos=table"
44+
# pygmentsUseClassic: false
45+
# pygmentsOptions: linenos=table
4146
# See https://help.farbox.com/pygments.html
4247

43-
# ****************************************************************************
44-
#
45-
# Docsy - Everything below this are Site Params
46-
#
47-
4848
# Comment out if you don't want the "print entire section" link enabled.
4949
# [outputs]
5050
# section = ["HTML", "print"]
51-
52-
# paramas
53-
54-
# Set Google Analytics to use GA4
55-
disableGtagForUniversalAnalytics: false
56-
57-
# First one is picked as the Twitter card image if not set on page.
58-
# images = ["images/project-illustration.png"]
59-
60-
# Menu title if your navbar has a versions selector to access old versions of your site.
61-
# This menu appears only if you have at least one [params.versions] set.
62-
version_menu: Releases
63-
64-
# Flag used in the "version-banner" partial to decide whether to display a
65-
# banner on every page indicating that this is an archived version of the docs.
66-
# Set this flag to "true" if you want to display the banner.
67-
archived_version: false
68-
69-
# The version number for the version of the docs represented in this doc set.
70-
# Used in the "version-banner" partial to display a version number for the
71-
# current doc set.
72-
version: 0.0
73-
74-
# A link to latest version of the docs. Used in the "version-banner" partial to
75-
# point people to the main doc site.
76-
url_latest_version: https://example.com
77-
78-
# Enable Algolia DocSearch
79-
#algolia_docsearch = false
80-
81-
# Enable Lunr.js offline search
82-
# offlineSearch = true
83-
84-
# Enable syntax highlighting and copy buttons on code blocks with Prism
85-
# Default "Chroma" syntax highlighter has no dot support, so use Prism instead
86-
prism_syntax_highlighting: false
87-

config/_default/languages.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
# See: https://gohugo.io/content-management/multilingual/
66
#
77
en:
8-
description: "Dedicated to restoring and preserving the Interlisp experience"
98
languageName: English"
109
# Weight used for sorting.
1110
weight: 1
12-
contentDir: content/en
11+
contentDir: content/en
12+
params:
13+
description: "Dedicated to restoring and preserving the Interlisp experience"

config/_default/markup.yaml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,28 @@
22
#
33
# Goldmark markdown processor setup
44
#
5+
# See: https://gohugo.io/getting-started/configuration-markup/#goldmark
6+
# for additional configuration options
7+
#
58
goldmark:
69
renderer:
710
unsafe: true
11+
#
12+
# Code block processing
13+
#
14+
# See: https://gohugo.io/getting-started/configuration-markup/#highlight
15+
# for additional information on configuration options.
16+
# https://www.docsy.dev/docs/adding-content/lookandfeel/#code-highlighting-with-chroma
17+
# contains Docsy specfiic code highlighting information
818
highlight:
919
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
20+
#style: solarized-dark
1021
style: tango
22+
codeFences: true
23+
noClasses: true
24+
hl_inline: false
1125
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
12-
# guessSyntax: true
26+
guessSyntax: true
27+
tabWidth: 4
28+
#lineNoStart: 1
29+
lineNos: false

config/_default/params.yaml

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,44 @@
22
#
33
# Parameters
44
#
5+
6+
# Set Google Analytics to use GA4
7+
disableGtagForUniversalAnalytics: false
8+
9+
# First one is picked as the Twitter card image if not set on page.
10+
# images = ["images/project-illustration.png"]
11+
12+
# Menu title if your navbar has a versions selector to access old versions of your site.
13+
# This menu appears only if you have at least one [params.versions] set.
14+
version_menu: Releases
15+
16+
# Flag used in the "version-banner" partial to decide whether to display a
17+
# banner on every page indicating that this is an archived version of the docs.
18+
# Set this flag to "true" if you want to display the banner.
19+
archived_version: false
20+
21+
# The version number for the version of the docs represented in this doc set.
22+
# Used in the "version-banner" partial to display a version number for the
23+
# current doc set.
24+
version: 0.0
25+
26+
# A link to latest version of the docs. Used in the "version-banner" partial to
27+
# point people to the main doc site.
28+
url_latest_version: https://example.com
29+
30+
# Enable syntax highlighting and copy buttons on code blocks with Prism
31+
# We are using code highlighting via Chroma. Chroma options are defined
32+
# in `markup.yaml`
33+
prism_syntax_highlighting: false
34+
535
# copyright: site copyright information
636
# authors: text list of authors
737
# from_year: year in copyright statement
838
#
939
copyright:
1040
authors: Interlisp.org
1141
from_year: 2024
42+
license: MIT
1243

1344
# github information
1445
# github_repo: url to repo of web site
@@ -65,7 +96,7 @@ links:
6596
# icon: "fa fa-envelope"
6697
# desc: "Discuss development issues around the project"
6798

68-
taxonomy:
99+
taxonomies:
69100
# Nothing defined
70101

71102
# User Interface Configuration options

content/en/software/install-and-run/windows/native/_index.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,31 +31,36 @@ When running on Windows natively, Medley will be installed into a directory of y
3131
<div align="center"><img alt="Windows Protection Dialog" height=333 width=311 src="../images/windows-protected.png"><p>&nbsp;</p></div>
3232

3333
## Multiple Installations
34+
3435
You can install multiple copies of Medley (e.g. different releases) on a single Windows. Simply run the Medley installation app and choose a different ***install_dir*** than any previous Medley installation.
3536

3637
Each Medley installation so installed will operate independently of other Medley installations, including having a separate Medley file system.
3738

3839
## Update Medley
40+
3941
To update any given Medley installation (e.g., to install a new release), download the updated native Medley Windows installer as per Step 1 in the **Install Medley** section above.
4042

4143
Run the installer app just downloaded and select the ***install_dir*** for the Medley installation you are updating.
4244

4345
The chosen Medley installation will be updated. Any user files (i.e., files created by the user that are not part of the Medley distribution) in the Medley file system will remain intact.
4446

4547
## Run Medley
48+
4649
Once it is installed, you can start Medley from either a Command window or a Powershell window. You cannot (currently) start Medley from the Start Menu or from an icon on the desktop.
4750

4851
From a Command window, type:
49-
```
52+
53+
```powershell
5054
cd <install_dir>
5155
medley <flags and options>
5256
```
53-
57+
5458
Example:
5559
<img alt="Start from Command Window" width=500 src="../images/windows-native-command.png">
56-
60+
5761
From a Powershell window, type:
58-
```
62+
63+
```powershell
5964
cd <install_dir>
6065
cmd /C medley <flags and options>
6166
```
@@ -71,24 +76,23 @@ This will bring up the Medley environment in a separate Window on your Windows d
7176

7277
![Medley window open on Windows desktop](../images/Medley-on-Windows.png)
7378

74-
75-
76-
7779
## Use Medley
80+
7881
Once Medley is up and running, see [here](/software/using-medley/) for tips on how to navigate and use the Medley environment.
7982

80-
To exit Medley, type ```(IL:LOGOUT)``` at any Exec window prompt.
83+
To exit Medley, type `(IL:LOGOUT)` at any Exec window prompt.
8184

8285
## Important Notes
83-
1. The file system from Medley's perspective differs somewhat from the file system from Window's perspective. Specifically, within Medley, the file system root (i.e., "{DSK}/" or "{UNIX}/") is mapped to the ***install_dir*** in the Windows file system. For example, if ***install_dir*** is ***C:\Users\Frank\Medley1***, then the Medley file known as ***{DSK}\<testdir>testfile.txt*** will be located in the Windows file system at ***C:\Users\Frank\Medley1\testdir\testfile.txt***
86+
87+
1. The file system from Medley's perspective differs somewhat from the file system from Window's perspective. Specifically, within Medley, the file system root (i.e., "{DSK}/" or "{UNIX}/") is mapped to the ***install_dir*** in the Windows file system. For example, if ***install_dir*** is ***C:\Users\Frank\Medley1***, then the Medley file known as ***{DSK}\<testdir>testfile.txt*** will be located in the Windows file system at ***C:\Users\Frank\Medley1\testdir\testfile.txt***
8488

8589
2. Also, from Medley you can refer to any file on a Windows drive using the reference ***{DSK}/[drive letter]/*** (or equivalently ***{DSK}<[drive letter]>***). For example, ***C:\User\Frank\Downloads\testfile.txt*** in Windows will be ***{DSK}/c/User/Frank/Downloads/testfile.txt*** in Medley.
8690

8791
3. Your Medley LOGINDIR will be ***/home/&lt;name>/il*** (or ***&lt;install_dir>\home\\&lt;name>\il*** from the Windows perspective), where ***&lt;name>*** is your Windows username.
8892
4. Medley code is stored in ***/medley*** (or ***&lt;install_dir>\medley*** from the Windows perspective).
8993
5. If you want to work with the Medley code using git, etc. You will probably find it easier to work with git within Cygwin rather than work with git in Windows. To work within the Medley-specific Cygwin, within a Powershell or Command window:
9094

91-
```
95+
```powershell
9296
PS C:\Users\Frank> cd <install_dir>
9397
PS C:\Users\Frank> .\bin\bash -login
9498
$ git clone https://github.com/Interlisp/medley.git gmedley
@@ -99,4 +103,3 @@ To exit Medley, type ```(IL:LOGOUT)``` at any Exec window prompt.
99103
This will get you a bash terminal running under the Medley-specific Cygwin - which means that the file names will be the same as in Medley.
100104

101105
6. The Medley-specific Cygwin install is rather minimal, so if you find you need other Linux tools to work with the Medley code, the Cygwin setup tool (which also functions as its package manager) is available at ***&lt;install_dir>\cygwin\setup_x86_64.exe*** (in Windows) or at ***/cygwin/setup_x86_64.exe*** (from within Cygwin bash).
102-

0 commit comments

Comments
 (0)