v3.6.0

Version 3.6.0

Release notes coming soon.

v3.5.0

Version 3.5.0

There were 2 changes in Retype 3.5.0.

New

1. New --pro flag during retype start to enable Pro features, see #612
2. New start.pro: true project config to enable Pro features, see #612

Improved

1. Path independent doc_theme local storage variable, see #624

v3.4.1

Version 3.4.1

There were 1 changes in Retype 3.4.1.

Fixed

1. Do not reset main tree nav on branding click, see #623

v3.4.0

Version 3.4.0

There were 5 changes in Retype 3.4.0.

New

1. New hub Project config with < header link, see #592
2. New toc Project and Page config and features, see #598
3. Automatically scroll ToC with page content, see #375

Improved

1. Upgrade Octicons icons library from v19.6.0 to v19.7.0

Fixed

1. Tree nav expanded state not saving

v3.3.0

Version 3.3.0

There were 3 changes in Retype 3.3.0.

New

1. New breadcrumb navigation with Project and Page configs, see #593
2. New list-icon css class to simplify creating Retype icon lists, see #370 and #603

Improved

1. Update all client libraries

v3.2.0

Version 3.2.0

There were 9 changes in Retype 3.2.0.

New

1. New Description List support

Improved

1. Upgrade Octicons icons library from v19.4.0 to v19.5.0
2. Upgrade Octicons icons library from v19.5.0 to v19.6.0

Fixed

1. Custom attributes on an image cause Retype to skip handling of component as a figure image
2. Custom css class not being applied correctly to table element
3. Escaping single braces inside inline code within headings
4. Adjust vertical alignment of Badge and Button components
5. Anchor is removed from redirect if set to internal page with anchor
6. Render icon on outbound link only if link contains plain or basic Markdown text, see #589

v3.1.0

Version 3.1.0

There were 16 changes in Retype 3.1.0, including four new features.

New

1. New outbound project config for outbound external link configuration, see #465
2. New support for Armenian, Kannada, Sankrit, and Telugu languages
3. The _includes/*.html files now have Templating support, see #282
4. New folder level visibility: private and visibility: protected support

Improved

1. Improved support for Cloudflare Rocket Loader, see #117, #380, and #580
2. Hide Tabs until finished rendering to avoid flash of unstyled content, see #570
3. Generated HTML syntax enhancements and clean up, see #583
4. Update the RU translation file, see #586
5. Upgrade to latest release of Mermaid, see #585
6. Add cache buster to _watch scripts during retype start
7. Update client libraries including vue, monaco-editor, simplebar, katex, and lunr-languages
8. Upgrade Octicons icons library from v19.1.0 to v19.3.0
9. Upgrade Octicons icons library from v19.3.0 to v19.4.0

Fixed

1. Not supported value WARNING on first build with new locale, see #573
2. Finish translation file updated
3. html lang=\"en\" attribute not updated if locale changes, see #574

v3.0.0

Version 3.0.0

There were 44 changes in Retype 3.0.0

New

1. PRO New visibility: private and visibility: protected pages, see #341
2. Multi-language interface support for 22 languages, see #18 and #24
3. New meta.title page level config, see #346 and #350
4. New CLI commands and flags, see #94 and #323
5. Prevent default web browser from being opened, see #323
6. Named regions with content, see #368
7. New {{ nonce }} token that emits a unique value that can be used for cache busting URLs in templates, see #324
8. Add welcome.md to the list of default page file names for the root input folder, see #461
9. New Inter and system based font-family, see #179
10. New default Welcome page
11. Change default search hotkey to k instead of /
12. New retype clean CLI command
13. Sticky TOC button
14. Context menu shortcuts for Retype components in Edit mode
15. Custom same name default page for a directory, see #511

Improved

1. Panel title missing from search index, see #363
2. Nice looking prompt for password protected pages
3. 1. Upgrade client and server dependencies
4. Upgrade to latest release of Turbo
5. Updated all Prism languages and created new dependency tree process, see #446
6. Argh... Poppins font doesn't support non-latin character glyphs (cyrillic), see #179
7. Use Inter font
8. Revise Plausible default script plausible.js to script.js
9. Remove Page Edit button on generated Welcome page
10. Links with icon that are images get empty alt attribute, see #523
11. Rename server project config to serve
12. Upgrade Octicons icons library from v17.2.0 to v17.3.0
13. Upgrade Octicons icons library from v17.9.0 to v17.10.0
14. Upgrade Octicons icons library from v17.10.0 to v17.10.1
15. Upgrade Octicons icons library from v17.10.2 to v17.11.1
16. Upgrade Octicons icons library from v17.11.1 to v17.12.0
17. Upgrade Octicons icons library from v17.12.0 to v18.0.0
18. Upgrade Octicons icons library from v18.2.0 to v18.3.0
19. Upgrade Octicons icons library from v18.3.0 to v19.0.0
20. Upgrade Octicons icons library from v19.0.0 to v19.1.0

Fixed

1. JavaScript error if one stacked Panel is missing content, see #388
2. --override command fails when used with a templating data object, see #509
3. Editor icons are not rendered after monaco has been upgraded
4. Propagate visibility to all nested pages in watch mode
5. Messed up meta tag content value generation with escaped sequence, see #513
6. mark-github icon issue in ref and file components, see #517
7. Exception thrown if :icon-: is added to a page
8. Case-insensitive in-memory file system
9. Prism theme issues after update to latest

v2.4.0

Version 2.4.0

There were 12 changes in Retype 2.4.0.

New

1. trailingSlash project config to instruct whether to add a trailing / when constructing links.
2. New generator.directoryIndex.append project config.
3. New host config on integrations.plausible. See #272.

Improved

1. Upgrade Octicons icons library from v17.0.0 to v17.2.0.
2. Update GetLicenseRequiredMessage with descriptive message. See #362.

Fixed

1. Extra phantom index.md file if Retype output path ends with a slash char.
2. Anchored links receive extraneous slash char when generator.directoryIndex.append: true.
3. Links to home page ignore generator.trailingShash setting.
4. Link at top-left logo has trailing slash when generator.trailingSlash is set to false.
5. Pressing enter on search results creates invalid url. See #333.
6. Parent folder prefixed with an _ underscore do not build properly. See #336.
7. Broken link to same page when generator.trailingSlash is false.

v2.3.0

Version 2.3.0

There were 19 changes in Retype 2.3.0.

New

1. Full relative URL pathing support. See #14, #133, #163, #184, #194, #222, #233, #239, #276.
2. generator.trailingSlash project config to instruct whether to add a trailing / when constructing links.
3. New search.preload project config to instruct Retype to preload the search index instead of on demand load.
4. New generator.directoryIndex.name project config for setting the default document name.
5. New RETYPE_DEFAULT_HOST environment variable. See #239.
6. New self-referential canonical tag for all pages.
7. Link to API pages using fully qualified class name path.

Improved

1. Revised cache buster to include full version number.

Fixed

1. Exclude files and pages within the _includes from the sitemap generation.
2. Exclude all contents of _includes directory from deploy.
3. Sidebar menu item is not highlighted when no trailing /.
4. Editor font request does not respect base path. See #318.
5. Syntax errors in yaml files results in corrupt category URLs. See #316.
6. links to the index document in the mobile sidebar footer not being resolved.
7. .yml files excluded from deploy even if explicitly declared in include. See #311.
8. og:url and twitter:url paths incorrect for API generated pages.
9. Include full version in the generator meta tag version.
10. Many categories extends beyond page width and does not wrap. See #316.

Breaking Changes

1. Switch generator.paths default value to relative.