docs: update Material theme dependencies

boriel · boriel · commit f6fcc1c2a89e · 2025-06-22T13:02:34.000+02:00
diff --git a/docs/archive.md b/docs/archive.md
@@ -10,7 +10,7 @@ repository (git).
 You can contribute to ZX BASIC by reporting possible bugs or improvement suggestions at the
 [forum](http://www.boriel.com/forum) or in social media.
 
-Latest stable version is <span style="color: green;">**1.18.1**</span>.
+The latest stable version is <span style={{color: "green"}}>**1.18.1**</span>.
 Click on the desired icon below to download the package suitable for your platform:
 
 * [<img src="https://zxbasic.readthedocs.io/en/docs/img/win32.png" alt="win32zip" width="32px"/>
diff --git a/docs/dim.md b/docs/dim.md
@@ -12,7 +12,7 @@ A [type](types.md) is a name for the kind of data (`Integer`, `Byte`, `String`,
 DIM <variable_name>[,<variable_name>...] [AS <type>] [= <value>]
 ```
 
-Where _<type>_ can be one of **INTEGER**, **BYTE**, **FLOAT**, etc.
+Where `<type>` can be one of **INTEGER**, **BYTE**, **FLOAT**, etc.
 See the list of [available types](types.md). If type is not specified, **FLOAT** will be used, unless you use
 a suffix (usually called _sigil_) like `$` or `%`.
 
@@ -46,7 +46,7 @@ Declaring a variable that has already been referenced in previous lines will res
 
 ### Examples of variable declarations
 
-```
+```basic
 REM Declares 'a' as a 16 bit signed integer variable
 DIM a AS INTEGER
 
diff --git a/docs/fastcall.md b/docs/fastcall.md
@@ -38,5 +38,5 @@ The above function, when called with `whatLetter(<value>)` will return the `<val
 `"A Man, A Plan, A Canal, Panama"`.
 
 ### Notes
-* Note that the A register already contains <value> when the inline assembly is reached.
+* Note that the A register already contains `<value>` when the inline assembly is reached.
 * Note that we do NOT need to put a ret opcode on the end of the assembly. The compiler will do that for us.
diff --git a/docs/for.md b/docs/for.md
@@ -55,7 +55,7 @@ Clearly, since the largest value a byte can hold is 255, it's not possible for i
 The variable will "wrap around" to 0 and as a result, the loop will not ever terminate.
 This can happen in much more subtle ways when `STEP` is used.
 There has to be "room" within the variable type for the iterator to exceed the terminator when it is being
-incremented by <step> amounts.
+incremented by `<step>` amounts.
 
 For example, this loop will neved end
 
diff --git a/docs/identifier.md b/docs/identifier.md
@@ -38,7 +38,7 @@ Identifiers shown in bold are taken from the Sinclair BASIC (beware their meanin
 * [CONST](const.md)
 * **[CONTINUE](continue.md)** **(statement)**
 * **[COS](cos.md)** **(function)**
-* **[DECLARE](declare.md)** **<modifier>**
+* **[DECLARE](declare.md)** **(modifier)**
 * **[DIM](dim.md)** **(statement)**
 * [DO](do.md) **(statement)**
 * **[DATA](data.md)** **(statement)**
@@ -79,7 +79,7 @@ Identifiers shown in bold are taken from the Sinclair BASIC (beware their meanin
 * **[PAPER](paper.md)** **(statement)**
 * **[PAUSE](pause.md)** **(statement)**
 * **[PEEK](peek.md)** **(function)**
-* **[PI](pi.md)** **<constant>**
+* **[PI](pi.md)** **(constant)**
 * **[PLOT](plot.md)** **(statement)**
 * **[POKE](poke.md)** **(statement)**
 * **[PRINT](print.md)** **(statement)**
@@ -91,8 +91,8 @@ Identifiers shown in bold are taken from the Sinclair BASIC (beware their meanin
 * **[RND](rnd.md)** **(function)**
 * **[SAVE](load.md)** **(statement)**
 * **[SGN](sgn.md)** **(function)**
-* [SHL or <<](shl.md) (operator)
-* [SHR or >>](shl.md) (operator)
+* [SHL or &lt;&lt;](shl.md) (operator)
+* [SHR or &gt;&gt;](shl.md) (operator)
 * **[SIN](sin.md)** **(function)**
 * **[SQR](sqr.md)** **(function)**
 * [StdCall](stdcall.md)
diff --git a/docs/img/zxbasic_logo.png b/docs/img/zxbasic_logo.png
diff --git a/docs/index.md b/docs/index.md
@@ -2,7 +2,7 @@
 * [About](about.md)
 <br />About the ZX BASIC SDK
 
-* [ChangeLog](https://github.com/boriel/zxbasic/blob/master/Changelog.md)
+* [ChangeLog](https://github.com/boriel-basic/zxbasic/blob/master/CHANGELOG.md)
 <br />A reduced list of changes/bugfixes
 
 * [Installation](installation.md)
diff --git a/docs/library/asc.bas.md b/docs/library/asc.bas.md
@@ -11,7 +11,7 @@ variable = asc(A$,n)
 ```
 Where `A$` is a string variable and `N` defines which character in the string we are interested in.
 
-##Requirements
+## Requirements
 
 ASC is a library function that must be included before it can be used. Use the following directive:
 
diff --git a/docs/library/print64x32.bas.md b/docs/library/print64x32.bas.md
@@ -14,9 +14,9 @@ thread http://www.boriel.com/forum/wishlist/64-char-print-32-lines-version-t680.
 Print64x32At(y,x)
 ```
 
-Moves the print64 system's print cursor to row Y, column X. Note that 0<= x <= 63 -
- that is the range of values for X can be up to 63. The range of values for Y is 0-31.
-* Note that the `print64x32` system's cursor position is independent from that of the
+Moves the print64 system's print cursor to row Y, column X. Note that `0 <= x <= 63` -
+ that is the range of values for X can be up to 63. The range of values for Y is `0-31`.
+* Note that the `print64x32` system's cursor position is independent of that of the
 ZX Basic Print routine, or any other, such as the print42 system.
 
 
@@ -41,7 +41,7 @@ An All in one function - sets the AT position, and prints the string.
 
 ## CODE
 
-```
+```basic
 SUB Print64x32At(Y as uByte,X as UByte)
  Poke(@Print64x32XCoord),X
  Poke (@Print64x32XCoord+1),Y
diff --git a/docs/library/puttile.md b/docs/library/puttile.md
@@ -3,10 +3,11 @@
 # putTile.bas
 
 This subroutine takes a 2X2 tile of data from the given address and copies
-it to the screen co-ordinates at (x, y) - x and y in character addresses, where 0 <= x <= 31 and 0 <= y < =23.
+it to the screen co-ordinates at `(x, y) - x` and `y` in character addresses, where `0 <= x <= 31` and
+`0 <= y < =23`.
 
 Note that this uses pushes and pops to move the data, using the fastest known data moving algorithm for the Z80.
-As a consequence, while active it uses ALL the registers, including alternates and IY and IX as well as the
+As a consequence, while active it uses ALL the registers, including alternates and `IY` and `IX` as well as the
 Stack Pointer SP. It is kind enough to put these back for the purposes of exiting the subroutine
 though - ZX BASIC uses that register quite extensively.
 
diff --git a/docs/library/randomstream.bas.md b/docs/library/randomstream.bas.md
@@ -95,7 +95,7 @@ end asm
 end function
 ```
 
-This function returns a value from zero to the specified limit number (limit <= 255).
+This function returns a value from zero to the specified limit number (limit &lt;= 255).
 You can therefore, for example, roll a dice by calling `randomLimit(5) + 1` to get 1-6.
 
 
diff --git a/docs/library/screen.md b/docs/library/screen.md
@@ -34,7 +34,7 @@ PRINT AT 0, 0; "The character at 9, 10 is "; c$
 ## Remarks
 
 * This function extends the one in Sinclair BASIC (and it's compatible with it) since it also allows rows 22 and 23.
-* When using _--sinclair_ cmd line parameter this function is already available (i.e. no _#include <screen.bas>_ sentence is needed)
+* When using _--sinclair_ cmd line parameter this function is already available (i.e. no `#include <screen.bas>` sentence is needed)
 
 ## See also
 
diff --git a/docs/on_goto.md b/docs/on_goto.md
@@ -35,7 +35,7 @@ In this example,
  * if `X` is 0, the execution will jump to line 50
  * if `X` is 1, it will jump to line 100;
  * if `X` is 2, it will jump to line 150.
- * If `X` is outside this range, the `ON ... GOTO` sentence will be ignored. </br>
+ * If `X` is outside this range, the `ON ... GOTO` sentence will be ignored. <br/>
    The program will print _"Invalid choice"_ and ask for input again.
 
 ## Remarks
diff --git a/docs/overrides/main.html b/docs/overrides/main.html
@@ -0,0 +1,6 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+  <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Press+Start+2P&display=swap">
+  <link rel="stylesheet" href="{{ 'stylesheets/extra.css' | url }}">
+{% endblock %}
diff --git a/docs/overrides/stylesheets/extra.css b/docs/overrides/stylesheets/extra.css
@@ -0,0 +1,30 @@
+/* Apply Press Start 2P font to the main header */
+.md-header__title {
+  font-family: 'Press Start 2P', cursive;
+}
+
+/* Ensure the site name maintains its size */
+.md-header__title .md-header__ellipsis {
+  font-size: 1.2rem;
+}
+
+.md-header__inner {
+  background-image: url('../img/zxbasic_logo.png');
+  background-repeat: no-repeat;
+  background-position: left center;
+  background-size: auto 100%;
+  padding-left: 50px; /* Add some padding to prevent text overlapping with the logo */
+}
+
+/*!* Make the logo size 100% of the header *!*/
+/*.md-header__button.md-logo {*/
+/*  height: 100%;*/
+/*  padding: 0;*/
+/*}*/
+
+/*.md-header__button.md-logo img {*/
+/*  padding: 0;*/
+/*  height: 100%;*/
+/*  margin: 0;*/
+/*  width: auto;*/
+/*}*/
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -29,3 +29,4 @@ requests==2.32.4
 six==1.16.0
 urllib3==2.2.3
 watchdog==6.0.0
+mkdocs-material
diff --git a/docs/return.md b/docs/return.md
@@ -13,9 +13,9 @@ RETURN [<expr>]
 
 
 Returns in the global scope (that is, outside any function or sub) are treated as return from [GO SUB](gosub.md).
-Otherwise they are considered as returning from the function or sub they are into.
+Otherwise, they are considered as returning from the function or sub they are into.
 
-> **WARNING**: Using RETURN in global scope without a GOSUB will mostly crash your program. <br>
+> **WARNING**: Using RETURN in global scope without a GOSUB will mostly crash your program. <br/>
 > Use `--stack-check` if you suspect you have this bug, to detect it.
 
 ### Example with GO SUB
diff --git a/docs/rnd.md b/docs/rnd.md
@@ -10,12 +10,12 @@ rnd
 
 ## Description
 
-Returns a number of type float in the range [0, 1) (i.e. 0 <= RND < 1), based on a random seed (see [RANDOMIZE](randomize.md)).
+Returns a number of type float in the range `[0, 1)` (i.e. `0 <= RND < 1`), based on a random seed (see [RANDOMIZE](randomize.md)).
 
 ## Examples
 
 
-```
+```basic
 REM Function to a random number in the range [first, last), or {first <= x < last}.
 Function rnd_range (first As Double, last As Double) As Float
     Function = Rnd * (last - first) + first
diff --git a/docs/shl.md b/docs/shl.md
@@ -15,7 +15,7 @@
 Bit shifts `<expr>` expression by `<distance>` bits to the left (`SHL`) or to the right (`SHR`).
 `SHR` can be replaced by `>>` and `SHL` by `<<` for more legibility.
 
-The <expr> argument should be of an integer type: `uByte`, `Byte`, `uInteger`, `Integer`, `uLong` or `Long`.
+The `<expr>` argument should be of an integer type: `uByte`, `Byte`, `uInteger`, `Integer`, `uLong` or `Long`.
 Use of bitshifting with fixed and float gives undefined results.
 `CAST` or `INT` should be used to convert floating point numbers into integer type numbers before use of the bit shift instructions.
 
diff --git a/docs/syntax.md b/docs/syntax.md
@@ -13,7 +13,7 @@ If you have ever programmed in legacy BASIC (either Sinclair BASIC or any other
 
 Nowadays this is not necessary, but ZX BASIC allows you to use lines and line numbers for compatibility (and nostalgic!) reasons:
 
-```
+```basic
 10 REM This is a comment.
 20 PRINT "Hello world!"
 ```
@@ -22,17 +22,18 @@ Nowadays this is not necessary, but ZX BASIC allows you to use lines and line nu
 Other than that, line numbers are ignored (well, not exactly: line numbers are treated as [labels](labels.md)).
 So the previous BASIC program could be also written this way:
 
-```
+```basic
 REM This is a comment.
 PRINT "Hello world!"
 ```
 
 
 ### Lines and sentences
 
-Since ZX BASIC is **line oriented** this implies that the ''end of line'' (also known as ''carriage return'' or ''<CR>'') is taken into account during syntax checking, and you cannot break lines in the middle of a sentence:
+Since ZX BASIC is **line oriented** this implies that the ''end of line'' (also known as ''carriage return'' or `<CR>`)
+is taken into account during syntax checking, and you cannot break lines in the middle of a sentence:
 
-```
+```basic
 REM The following line has a syntax error
 PRINT
     "Hello world!"
@@ -42,7 +43,7 @@ PRINT
 Other languages (like C or Pascal) allows this because they're not line oriented. If you need to break a line, use the
 underline character (**_**) at the end of line to tell the compiler the current line continues in the next one:
 
-```
+```basic
 REM The following line is broken into two, but it's ok
 PRINT _
     "Hello world!"
@@ -53,7 +54,7 @@ PRINT _
 
 A sentence is the simplest BASIC instruction (e.g. **[PRINT](print.md)**). Sentences might contain ''arguments'' and can be separated by a ''colon'' (:) as in Sinclair BASIC or by ''end of line''. A ''block of sentences'' are just a group of sentences one after another. Usually the reserved word **END** denotes the end of such block. E.g.
 
-```
+```basic
 IF a > b THEN
     PRINT "A is greater than B"
     PRINT "and that's all"
@@ -86,7 +87,7 @@ So, `C9` hex should be written as `0C9h` or `$C9`.
 
 As shown in the previous examples, the ''reserved word'' **REM** is used for comments and ''remarks''. However, you can also use the single quote (') character for comments instead of **REM**:
 
-```
+```basic
 10 REM This is a comment
 20 'This is also a comment
 30 PRINT "Hello world!"
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: ZX Basic Wiki
+site_name: Boriel Basic Docs
 nav:
   - Home: index.md
   - Syntax: syntax.md
@@ -8,16 +8,41 @@ nav:
   - About: about.md
 
 theme:
-  name: readthedocs
+  name: material
+  #logo: img/zxbasic_logo.png
+  palette:
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+  # Custom font for the header
+  font:
+    text: Roboto
+    code: Roboto Mono
+
+  # Custom CSS to apply Press Start 2P font to the header
+  custom_dir: docs/overrides
 
 docs_dir: docs
 
 markdown_extensions:
   - tables
   - pymdownx.highlight:
+      linenums: true
       anchor_linenums: true
       line_spans: __span
       pygments_lang_class: true
+  - pymdownx.keys
   - pymdownx.inlinehilite
   - pymdownx.snippets
   - pymdownx.superfences
