From cf7fe938a2e3fd46ecefa8560beb25a65085fd9e Mon Sep 17 00:00:00 2001 From: harryob <55142896+harryob@users.noreply.github.com> Date: Tue, 6 Aug 2024 09:57:20 +0100 Subject: [PATCH] config documentation and additional readme notes --- README.md | 4 ++++ config.toml | 5 ++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5ccc759eb..0a8b32123 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,10 @@ And these frontmatter fields are automatically populated, and should not be chan - Override status (`is_override`) - Unimplemented status (`od_unimplemented`) +### Not Autodocced + +"Procs" that are implemented as defines in DMStandard are not automatically populated. For example, ASSERT and REGEX_QUOTE. Furthermore, many procs are not present in DMStandard, such as istype() and prob() - these can be found [here](https://github.com/OpenDreamProject/OpenDream/blob/master/DMCompiler/Compiler/DM/DMParser.cs#L2460) in the OpenDream source code. + ## [extra] Documentation Zola allows us to put arbitrary TOML under the [extra] section, which we do for the various page types. This includes the fields that editors can set, not the ones pulled from DMStandard (above). diff --git a/config.toml b/config.toml index 8fa305976..0a87f51a2 100644 --- a/config.toml +++ b/config.toml @@ -2,13 +2,12 @@ base_url = "https://harryob.github.io/od-dm-reference" [markdown] -# Whether to do syntax highlighting -# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola highlight_code = true +# Includes the DreamMaker syntax highlighting extra_syntaxes_and_themes = ["syntaxes"] [extra] -# Put all your custom variables here +# Used to link to the repository in pages repo = "https://github.com/harryob/od-dm-reference" branch = "main"