Skip to content

Commit

Permalink
config documentation and additional readme notes
Browse files Browse the repository at this point in the history
  • Loading branch information
hry-gh committed Aug 6, 2024
1 parent 9957657 commit cf7fe93
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
5 changes: 2 additions & 3 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"

0 comments on commit cf7fe93

Please sign in to comment.