Changelog
2.14.0 (2024-11-05)
Features
- dedent code after transforming (744f9c5)
2.13.0 (2024-11-04)
Features
- allow to cut snippets from examples (db07585)
- new
extractExamplesProcessor
(2559b06), closes #59 - strip eslint comments from examples (5dd604e)
Bug Fixes
cacheFolder
is optional (e4ad918)exampleFolders
is optional (bf4893d)markdown.messagebox
is optional (d558a90)motdProcessor
options is optional (d43c0cb)outputFolder
is optional (53dde23)- only match filenames when matching source files (aec08fa)
Performance Improvements
- reuse same manifest
md
instance for all calls (616f226)
2.12.0 (2024-11-03)
Features
- new processor
fileRedirctProcessor
for html based redirects (17c18cc), closes #77 - new processor
redirctFileProcessor
for netlify-style redirects (a326b5f), closes #77 - support tagging redirects on documents (e695ec6), closes #76
Bug Fixes
- deps: update dependency mermaid to v11.4.0 (b408d94)
2.11.4 (2024-11-01)
Bug Fixes
- code in messagebox and messagebox styling (7ea1600)
- deps: update dependency nano-spawn to v0.2.0 (b041385)
2.11.3 (2024-10-29)
Bug Fixes
- set correct language in manifest (d1f1e0f)
2.11.2 (2024-10-28)
Bug Fixes
- add latest version prefix (762e9c3)
2.11.1 (2024-10-28)
Bug Fixes
- resolve latest version properly (d496835)
2.11.0 (2024-10-28)
Features
- motd API (a4ed61d)
Bug Fixes
- selectable version (f12db4d)
2.10.0 (2024-10-23)
Features
- support vue composition and scoped styling in examples (8f00924)
Bug Fixes
- dont print exceptions twice (e8c93a9)
- ensure compiling sass works when package is linked with
npm link
(59f3753) - load layout templates from custom directories (c2f37d5)
2.9.2 (2024-10-15)
Bug Fixes
2.9.1 (2024-10-14)
Bug Fixes
2.9.0 (2024-10-11)
Features
- add styling for mermaid git graph (770bbc9)
- new
sourceFiles
parameter to limitsourceUrlProcessor
results (30c7906)
Bug Fixes
- fix performance regression when using
sourceUrlProcessor
(d024574)
2.8.0 (2024-10-09)
Features
- support
<details>
element in markdown content (ec2a9cd) - support markdown content in messagebox titles (36be401)
Bug Fixes
- fix
cannot read property of null
when clicking on topnav (6744894)
2.7.0 (2024-10-08)
Features
Bug Fixes
- deps: update dependency mermaid to v11.3.0 (1e8e72c)
- make responsive menu hidden while page is loading (5512b72)
- move responsive topnav styling to layout styling (46c9c24), closes #101 #102
- reload responsive menu on site navigation (a613d6d), closes #100
- rewrite moduleImporter (refs SB-4982) (8ad44fc)
2.6.0 (2024-10-05)
Features
- add debounce method (refs SFKUI-6794) (86ba797)
- add ipopupmenu styling (refs SFKUI-6794) (98545d9)
- new
Optional
tag (428e685) - new layout
article
(e55727f) - new messagebox container for rendering messageboxes (d75c97e)
- responsive navbar (fixes SFKUI-6794) (ce86247)
- support
short-title
attribute (863154b) - support definition lists (63fd90b)
Bug Fixes
- branch name when running on github actions (d4bbca5)
- fix clipped bullet in lists (7519d60), closes #89
- fix redos issue with inline tags (8b7b92b)
- handle inline tags with not content and multiple brackets (5682319)
2.5.0 (2024-10-04)
Features
- expose
onContentReady
to consumers (7330ac5)
2.4.0 (2024-09-23)
Features
- expose a limited set of esbuild options to js assets (aeb8f81)
- fullscreen support for html examples (aa92d6e)
- sass module importer (refs SB-4982) (592dd06)
Bug Fixes
- deps: update dependency piscina to v4.7.0 (66cca41)
- vue: handle when vue component is missing
<script>
(5daa4eb)
2.3.0 (2024-09-20)
Features
repository
placeholder in format strings (3d58208)- added support for NodePackageImporter (refs SB-4982) (dd6c0c0)
- asset priority settings for sorting the order they run in (e93ec83)
- detect github pull requests (3c1073d)
Bug Fixes
2.2.2 (2024-09-13)
Bug Fixes
- deps: update dependency express to v4.20.0 [security] (dd9d77b)
- deps: update dependency mermaid to v11.2.0 (e5b84b9)
2.2.1 (2024-09-11)
Bug Fixes
- invalid layout when mobile and expanded menu (refs SFKUI-6794) (7284025)
2.2.0 (2024-09-10)
Features
- hide sidenav on click (fixes SFKUI-6767) (0256f7b)
Bug Fixes
- deps: update dependency mermaid to v11.1.1 (13d79bc)
- hide details marker on Safari (refs SFKUI-6764) (c4da3bb)
2.1.0 (2024-09-09)
Features
- api:
compileScript
andcompileStyle
accepts URL parameter (a844004) - deps: update dependency execa to v9 (1735bbd)
- deps: update dependency glob to v11 (9417f08)
- processors may contain optional runtime scripts (bcf51d7)
- skeleton element for mermaid diagrams (bed00fb)
- support
hash
andshort
placeholders forurlFormat
insourceUrlProcessor
(174dd97)
Bug Fixes
- ensure asset directory exists before moving script assets (5767e2f)
- fix broken mermaid diagrams after navigation (91490fc)
- hide seconds from buildinfo (9b0fec5)
- include original error message when
compileScript
fails (122aea3) - remove non-working support for arrays to
compileScript
(c30803a) - resolve
versions.json
proper when site is in a subdirectory (ae44ab7)
2.0.0 (2024-09-07)
⚠ BREAKING CHANGES
- drop vue 2 support
- deps: NodeJS v20 or later is now required.
Features
Bug Fixes
- try to fix nav icon size on older mobile devices (b3e601d)
1.33.1 (2024-09-06)
Bug Fixes
- deps: update dependency mermaid to v11.1.0 (fca5fa2)
1.33.0 (2024-09-05)
Features
Bug Fixes
- do not render empty outline (4f06652)
- heading size in examples (fc5e087)
- responsive table of contents (a478f56)
1.32.0 (2024-08-30)
Features
- deps: update dependency mermaid to v11 (984c468)
1.31.0 (2024-08-22)
Features
- add option enabled to
selectableVersionProcessor
(27d9ff2) - generate component links (fixes SFKUI-6698) (90165d5)
1.30.10 (2024-08-16)
Bug Fixes
- show active header in outline (7293119)
1.30.9 (2024-08-09)
Bug Fixes
- deps: update dependency vue-docgen-api to v4.79.2 (f8c3494)
1.30.8 (2024-07-26)
Bug Fixes
- deps: update dependency semver to v7.6.3 (05ad04a)
1.30.7 (2024-07-19)
Bug Fixes
- deps: update dependency glob to v10.4.5 (d6006a2)
1.30.6 (2024-07-12)
Bug Fixes
- deps: update dependency highlight.js to v11.10.0 (818dd66)
- deps: update dependency vue-docgen-api to v4.79.1 (5693008)
1.30.5 (2024-07-05)
Bug Fixes
- deps: update dependency piscina to v4.6.1 (c967c07)
1.30.4 (2024-06-28)
Bug Fixes
- deps: update dependency glob to v10.4.2 (0581866)
- deps: update dependency piscina to v4.6.0 (65ad2c3)
1.30.3 (2024-06-16)
Bug Fixes
- fix fullscreen button link (28a62ac)
1.30.2 (2024-06-12)
Bug Fixes
- fix jenkins pull request id incorrectly including
PR-
prefix (739b9b1) - move
scmInfo
to importable macro in separate file (893b315) - move PR info on it's own line in version info (d5f6e54)
1.30.1 (2024-06-12)
Bug Fixes
- fix broken external links after navigating to subfolder (9d3ed2b)
- fix broken search results when navigating from subdirectory (6e23db6)
- fix theme selector being stored per directory instead of globally (90e90e5)
- prevent theme from flickering when loading page (89339c1)
1.30.0 (2024-05-28)
Features
- new
motdProcessor
replacing now deprecatedversionBannerProcessor
(c96aaed)
Bug Fixes
- deps: update dependency glob to v10.3.16 (60aea60)
- deps: update dependency glob to v10.4.1 (381a6c1)
- deps: update dependency piscina to v4.5.1 (7339a08)
1.29.2 (2024-05-24)
Bug Fixes
- deps: update dependency mermaid to v10.9.1 (1dffc55)
- deps: update dependency piscina to v4.5.0 (4e378bb)
1.29.1 (2024-05-17)
Bug Fixes
- deps: update dependency glob to v10.3.14 (ccadc65)
- deps: update dependency glob to v10.3.15 (4916055)
- deps: update dependency semver to v7.6.1 (4f02106)
- deps: update dependency semver to v7.6.2 (d77d8e4)
1.29.0 (2024-05-08)
Features
Performance Improvements
- skip running example compiler when there are no examples to compile (67800d8)
1.28.0 (2024-05-06)
Features
- add new
defineSources
helper (5b4b9ad) - backport topnav processor (bf1e759)
- new css-variables for text colors (b5d9c57)
- queryable example metadata (15e01a5)
- version processor can optionally include scm information (0680cd8)
1.27.0 (2024-04-25)
Features
- deps: make
express
an optional peer dependency (c6f1ea1)
Bug Fixes
- fix relative urls appending extra trailing
/
(f949396)
1.26.0 (2024-04-24)
Features
- add a unique id to each example (4413f26)
- api: new
manifest()
method for programmatically retrieving maniest (b3020f2) - api: new
manifestProcessor
(c5029b4) - api: support
[hash]
inoutputName
(9e257e0)
Bug Fixes
- correct css-variables filepath for windows (f267b91)
1.25.3 (2024-04-20)
Bug Fixes
- balanced header text wrapping (7a11c46)
- separate variables for default font-weight and headings (e941260)
1.25.2 (2024-04-17)
Bug Fixes
- fix EPERM error when renaming output folder on Windows (c82f5f1)
1.25.1 (2024-04-16)
Bug Fixes
1.25.0 (2024-04-15)
Features
- deps: update dependency piscina to v4 (5e7d50d)
Bug Fixes
- add sri for most resources currently missing it (336e309)
1.24.0 (2024-04-12)
Features
- initial public version (6352bbc)