@heroiclands/package-build 23.13.0 → 24.0.0

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @heroiclands/package-build
 
+## 24.0.0
+
+### Major Changes
+
+**Upgrading**
+
+- Build and preview sites with `package-build site build` and `package-build site serve`; Hugo is no longer used, so update your scripts and workflows and drop its install step.
+- Remove `site.hugo` from `package-build.config.yaml`, and write `[x]{.glyph}` or `[signs]{.cartouche}` where a note used a Hugo shortcode.
+- Describe a verse's metre, rhyme or syllable pattern in prose, since `meter=`, `rhyme=` and `syllables=` are errors; write a language's `stress` as a map, `{ two: first, longer: penultimate, mark: acute }`.
+- Use `engine.wikilinks` in place of `engine.webWikilinks`, and copy the new `assets/preview/gitea.ini` into the Gitea renderer's `app.ini`.
+
+### Patch Changes
+
+**Every surface**
+
+- Foundry journals, the editor preview and the book render alerts, verse, captions, footnotes, pictures and secret blocks alike; an editor passes its content index to `renderPreview` as `previewIndex`.
+- Fenced code that names a language is highlighted, a captioned map reads **Map N**, and `[label]{.glyph}` and `[label]{.cartouche}` set a sign or framed seal from `icons/<slug>.svg` or `images/cartouches/<slug>.svg`.
+
+**Fixes**
+
+- Errors on a note's first body line are reported at their own column, `extends` in a `.markdownlint-cli2` options file applies, building pictures twice reports no collisions, and `npm audit` reports no KaTeX advisory.
+
+**Languages and scripts**
+
+- A `doc` note lists a setting's core concepts in `data.concepts`, a language with `core: true` must cover them, words name theirs in `concept`, and `package-build core` lists the gaps.
+- Emphasis in a script reads as its own mark, a red rubric or an overline, stated in `data.script` or a language's `data.emphasis`; `_…_` and `__…__` work as `*…*` and `**…**` do.
+- A mapping with `logographic: true` writes each word from the lexicon by its own writing or its parts', and a word with neither is an error.
+- A verse fence's `scan=` names a metre declared in `data.metres`, and a line that cannot have its beats is a warning; a word's `variants` take the language's endings.
+
+**Sites**
+
+- `package-build site build` renders every page, `404.html`, `sitemap.xml` and the search index, minified; `site serve` rebuilds a page when its note or the theme changes and reloads the browser.
+- Blog posts are `doc` notes of `subType: post` with `data.date` and `data.author`, listed newest first and fed as Atom by `site.feed`; `site.sections` and `site.tags` add section and tag pages.
+- `site.base: /` serves a site at its domain's root, where `site.sitemaps` and `site.mergeIndexes` extend its sitemap index, `robots.txt` and search across package sites.
+- Search filters by package, type, subtype, culture, continent, region, author and tag, ranks a note's name first, shows its icon, and leaves out `.secret` sections.
+
 ## 23.13.0
 
 ### Minor Changes

package/README.md

@@ -47,7 +47,7 @@ pre-push hook. Run `npm test` and the other checks directly, or use
 
 ## Documentation
 
-The documentation lives in the Markdown files in this repository. Start with [the documentation home](docs/index.md). This toolchain does not build its own site or book. A Hugo theme dependency would form a cycle because the theme uses package-build for releases.
+The documentation lives in the Markdown files in this repository. Start with [the documentation home](docs/index.md). This toolchain does not build its own site or book.
 
 | Topic                                             | Guide                                                                     |
 | ------------------------------------------------- | ------------------------------------------------------------------------- |
@@ -69,6 +69,7 @@ The documentation lives in the Markdown files in this repository. Start with [th
 | Localization and templates                        | [Localization](docs/guides/localization.md)                               |
 | Foundry integration testing                       | [End-to-end testing](docs/guides/e2e.md), including an optional S3 server |
 | Release and deployment                            | [Release and deploy](docs/guides/release-and-deploy.md)                   |
+| Invented languages and scripts                    | [Write in invented scripts](docs/guides/writing-in-invented-scripts.md)   |
 | Buffer-only preview and Gitea rendering           | [Source preview](docs/source-preview.md)                                  |
 | Every CLI command                                 | [Commands](docs/commands.md)                                              |
 | Every build setting                               | [Configuration](docs/configuration.md)                                    |

package/assets/preview/gitea.ini

@@ -9,12 +9,12 @@ RENDER_CONTENT_MODE = sanitized
 [markup.sanitizer.markdown.previewDiv]
 ELEMENT = div
 ALLOW_ATTR = class
-REGEXP = ^(hl-preview(?:-[a-z-]+)?|alert(?:-(?:note|tip|important|warning))?|content-figure(?:-[a-z-]+)?|verse)( (hl-preview(?:-[a-z-]+)?|alert(?:-(?:note|tip|important|warning))?|content-figure(?:-[a-z-]+)?|verse))*$
+REGEXP = ^(hl-preview(?:-[a-z-]+)?|content-figure(?:-[a-z-]+)?|verse(?:-[a-z-]+)?|border)( (hl-preview(?:-[a-z-]+)?|content-figure(?:-[a-z-]+)?|verse(?:-[a-z-]+)?|border))*$
 
 [markup.sanitizer.markdown.previewSpan]
 ELEMENT = span
 ALLOW_ATTR = class
-REGEXP = ^(hl-preview-[a-z-]+|alert-(?:title|icon)|verse-[a-z-]+|i[0-8])( (hl-preview-[a-z-]+|alert-(?:title|icon)|verse-[a-z-]+|i[0-8]))*$
+REGEXP = ^(hl-preview-[a-z-]+|alert-(?:title|icon)|verse-[a-z-]+|i[0-8]|hljs-[a-z_-]+|[a-z]+_{1,2})( (hl-preview-[a-z-]+|alert-(?:title|icon)|verse-[a-z-]+|i[0-8]|hljs-[a-z_-]+|[a-z]+_{1,2}))*$
 
 [markup.sanitizer.markdown.previewPre]
 ELEMENT = pre
@@ -29,7 +29,7 @@ REGEXP = ^(hl-preview-fence|language-[A-Za-z0-9_-]+)$
 [markup.sanitizer.markdown.previewAside]
 ELEMENT = aside
 ALLOW_ATTR = class
-REGEXP = ^hl-preview-infobox$
+REGEXP = ^(hl-preview-infobox|alert alert-(?:note|tip|important|warning)(?: [a-z][a-z0-9-]*)*)$
 
 [markup.sanitizer.markdown.alertSvgFill]
 ELEMENT = svg
@@ -56,15 +56,20 @@ ELEMENT = main
 ALLOW_ATTR = class
 REGEXP = ^hl-preview-main$
 
-[markup.sanitizer.markdown.alertBox]
-ELEMENT = blockquote
+[markup.sanitizer.markdown.alertTitle]
+ELEMENT = header
 ALLOW_ATTR = class
-REGEXP = ^alert alert-(note|tip|important|warning)$
+REGEXP = ^alert-title$
+
+[markup.sanitizer.markdown.noteImage]
+ELEMENT = figure
+ALLOW_ATTR = class
+REGEXP = ^note-image( note-image-[a-z-]+)*$
 
 [markup.sanitizer.markdown.previewParagraph]
 ELEMENT = p
 ALLOW_ATTR = class
-REGEXP = ^(alert-title|content-figure-label)$
+REGEXP = ^content-figure-label$
 
 [markup.sanitizer.markdown.alertSvgClass]
 ELEMENT = svg

package/assets/styles/content-base.css

@@ -17,7 +17,8 @@
  *
  * It carries what every package's compiled content needs to read in Foundry as
  * it does in the preview and on the site: definition lists, verse, alerts,
- * inline spoilers, marked names, unresolved links and captioned blocks. Every
+ * inline spoilers, marked names, unresolved links, captioned blocks and
+ * highlighted code. Every
  * class the Foundry renderer emits is styled here or exempted by name in
  * `tests/base-styles.test.ts`. A package keeps its own stylesheet for its own
  * needs and overrides anything here from it.
@@ -119,6 +120,10 @@
     }
 }
 
+/* preview:shared — verse, marked text and generic families. The rules between
+ * the two markers are also the editor preview's stylesheet, with the content
+ * roots replaced by the preview's own. */
+
 /* Each verse line breaks in the markup; each paragraph is a stanza. */
 :is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .verse {
     margin: 1.5rem 0;
@@ -280,6 +285,33 @@
     text-align: start;
 }
 
+/*
+ * Emphasis in a script follows the script's convention, never a weight or a
+ * slant the face does not have: the element keeps the face's Regular, and its
+ * class sets the convention. The rubric is carried by colour alone, so each
+ * half holds 4.5:1 on Foundry's journal page in its theme and stays apart from
+ * the body text in lightness; a package that overrides it re-checks both.
+ */
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) {
+    --pb-rubric: #9c281b;
+    --pb-rubric: light-dark(#9c281b, #e0705f);
+}
+
+.script :is(em, strong) {
+    font-style: normal;
+    font-weight: inherit;
+    font-synthesis: none;
+}
+
+.emph-rubric {
+    color: var(--pb-rubric);
+}
+
+.emph-overline {
+    text-decoration-line: overline;
+    text-decoration-skip-ink: none;
+}
+
 /* Text set in the reader's generic families, `font=serif`, `sans` and `mono`. */
 .font-serif {
     font-family: serif;
@@ -293,6 +325,8 @@
     font-family: monospace;
 }
 
+/* /preview:shared */
+
 /*
  * Historical info/warn section classes remain available for styled prose.
  * New alerts use the separate alert classes below.
@@ -469,6 +503,9 @@
     }
 }
 
+/* preview:shared — inline spoilers, names, unresolved links, captioned blocks,
+ * pictures and highlighted code, to the end of the file. */
+
 /* Inline spoilers reveal on pointer hover or keyboard focus. Native secret
  * sections retain Foundry's separate GM reveal control. */
 :is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
@@ -578,3 +615,115 @@
     border: 1px solid var(--pb-figure-border, currentcolor);
     border-radius: 4px;
 }
+
+/*
+ * Code a fence names a language for is highlighted when the page is built, and
+ * its token classes are coloured here. Each colour defers to a custom property
+ * so a package or a theme can replace it, and `light-dark()` follows the colour
+ * scheme Foundry sets.
+ */
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-keyword,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .hljs-variable.language_,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-doctag,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-selector-tag,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-template-tag,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-type {
+    color: var(--pb-code-keyword, light-dark(#cf222e, #ff7b72));
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-title,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-title.class_,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .hljs-title.class_.inherited__,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .hljs-title.function_,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .hljs-title.function_.invoke__,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-selector-id {
+    color: var(--pb-code-title, light-dark(#8250df, #d2a8ff));
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-attr,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-attribute,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-literal,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-meta,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-number,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-operator,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-variable,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-selector-attr,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .hljs-selector-class,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-property,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .hljs-variable.constant_,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .hljs-template-variable {
+    color: var(--pb-code-constant, light-dark(#0550ae, #79c0ff));
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-regexp,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-string,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .hljs-meta.hljs-string,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-char.escape_ {
+    color: var(--pb-code-string, light-dark(#0a3069, #a5d6ff));
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-built_in,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-symbol,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-meta.prompt_,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-bullet {
+    color: var(--pb-code-builtin, light-dark(#953800, #ffa657));
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-comment,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-code,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-formula {
+    color: var(--pb-code-comment, light-dark(#59636e, #9198a1));
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-name,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-quote,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .hljs-selector-pseudo,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-tag {
+    color: var(--pb-code-name, light-dark(#116329, #7ee787));
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-subst,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-params,
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-punctuation {
+    color: var(--pb-code-plain, inherit);
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-section {
+    color: var(--pb-code-constant, light-dark(#0550ae, #79c0ff));
+    font-weight: 700;
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-emphasis {
+    font-style: italic;
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-strong {
+    font-weight: 700;
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-link {
+    color: var(--pb-code-constant, light-dark(#0550ae, #79c0ff));
+    text-decoration: underline;
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-addition {
+    color: var(--pb-code-addition, light-dark(#116329, #aff5b4));
+    background-color: var(--pb-code-addition-fill, light-dark(#dafbe1, #033a16));
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .hljs-deletion {
+    color: var(--pb-code-deletion, light-dark(#82071e, #ffdcd7));
+    background-color: var(--pb-code-deletion-fill, light-dark(#ffebe9, #67060c));
+}
+
+/* /preview:shared */