# Changelog

1. PRO New Backlinks Component, plus Project, and Page settings
2. New color preview chip for hexadecimal color codes
3. New detection of dark mode image file names and automatic switching between light and dark images
4. New favicon dark variant automatic discovery and automatic light/dark switching
5. New triple-star *** description syntax for page descriptions
6. New templating.loopLimit Project configuration setting
7. New target setting on Page, see #795

1. Added translate="no" attribute to inline <code> elements
2. Remove extra bottom margin when a Callout includes a List, see #769
3. Add broader theme variables support for Headings H1 > H6
4. Improve CNAME validation to help prevent deployment misconfigurations
5. Print stylesheet refinements, see #782
6. Upgrade Octicons icons library from v19.15.3 to v19.21.2

1. Fixed skeleton rendering issues with Search and Filter input fields
2. Fixed favicon auto-discovery path resolution and ensure configured favicons always render

1. PRO New theme color customization for base and dark themes, see #42 and #697
2. PRO New branding.baseColor setting for quick configuration of the project base-color theme variable to left navigation nodes, see #763
3. PRO New Page level nav.badge setting for adding a badge component to left navigation nodes, see #763
4. New 3-way Light, Dark, and System color scheme selector, see #421 and #624
5. New pipe notation syntax support for adding variant to Button, Badge, and Navigation Badge components
6. New support for icon-only links in header and footer
7. New base variant for Button, Badge, and Callout

1. Upgrade to latest release of VueJS
2. Update to latest v3.3.x release of TailwindCSS
3. Add keyboard hint into Search field, see #762
4. Improve templating support within footer.copyright project setting
5. Hide the placeholder text in the Search and Filter input fields when focused, see #762
6. Upgrade Octicons icons library from v19.15.2 to v19.15.3
7. Improve icon margins on icon-only Badge and Button components
8. Improve print mode rendering

1. Fixed search input attribute value not being rendered, see #764

1. PRO New nextprev project and page setting to configure Next and Previous page navigation, see #34
2. New Inline and block level hidden comments using wrapping %%
3. New Callout tip variant
4. New Page meta.description configuration, see #638
5. New support for adding generic attribute syntax on list items, see #603
6. New custom anchors using Obsidian ^block syntax

1. Handle case-sensitive #anchor links and resolve if case-insensitive version found
2. Add translate=\"no\" attribute to code block <pre> element
3. Add unique id values to important template elements, see #538, #639 and #640
4. Improve automatic smooth scroll to #anchor on document load
5. Added rounded css classes including rounded-xl, rounded-2xl, rounded-3xl, rounded-4xl and rounded-full, see v3.10.1

1. Fixed exception being thrown if order set with a huge number, see #751
2. Fixed pipe separated dimensions issue where dimensions were added to image label if label is empty
3. Fixed code block height not rendering correctly if no content in code block
4. Fixed build error with > [!hint] callout, see v3.10.1
5. Fixed lists with lowercase letters and roman numerals not rendered correctly, see #760, see v3.10.1
6. Fixed main layout background color that does not match sidebar background color, see #759, see v3.10.1

1. PRO New nav.icons.enabled Project setting to hide icons in navigation, see #381 and #621
2. PRO New scheme.mode project setting to default initial page rendering to be explicit day,night, or system modes, see #421
3. New automatic conversion of details > summary elements into Retype Panel component
4. New print friendly stylesheet to enable better printing of pages, see #85 and #628
5. New Obsidian style of setting width and height of image, see #694
6. New question callout component variant, see #223
7. New support for Notion style callout syntax
8. New support for Hextra style callout syntax
9. New support for generic Alert callout syntax style
10. New support for Just the Docs style of callouts
11. New support for Sphinx style callout syntax

1. Rename the Alert component to Callout
2. Support titles on Obsidian style callout syntax plus all Obsidian callout types
3. Upgrade Octicons icons library from v19.15.1 to v19.15.2
4. Add background color on nav nodes and refinements to site label

1. layout: page failing to be recognized on Pages within sub-folders, see #732
2. Complex anchor id scenarios not being normalized as expected
3. WikiLink anchor only links to same page anchor not rendering a link
4. Callout parser confuses title for variant when space follows opening !!!

1. PRO New stack navigation mode for Project and Page settings, see #621
2. New Greek and Hebrew language support, see #730
3. New YouTube link parsing and embed template generation, see #51
4. New support for including a file outside the project root when using {{ include }}, see #734
5. New WikiLink and image WikiLink syntax support, including building Obsidian vaults

1. Switched order of theme switcher buttons with sun in light mode and moon in dark mode
2. Revised default server to host on port 5001 instead of 5000, see #688
3. Refinements to automatic detection of search index languages
4. Improve project locale-specific template rendering
5. Minor UI refinements
6. Add home.md to list of default pages in a directory
7. Add permalink as an alias of route page configuration
8. Support Description Lists with Single-Space After Colon, see #740
9. Upgrade Mermaid to the latest v11.6.0 release, see #627, #656, and #716
10. Improve automatic handling of GitBook image exports, see release v3.8.1

1. Retype build errors if no matching url is found in wallet, see #549
2. Fix float rendering issue with definition list content wrapping multiple rows, see #693

1. New -v flag as an alias on retype --version in CLI
2. New showSidebarFilter project setting to hide navigation Filter component, see #538

1. Restore support for official Retype Docker containers
2. Upgrade Octicons to latest v19.15.1 release
3. Add support for .NET 9.0 and upgrade internal frameworks

1. Fixed Retype version number where build hash was being appended

1. PRO New --strict parameter for retype build, see #618

1. Upgrade Octicons icons library from v19.7.0 to v19.8.0
2. Allow words to break for the ToC and Headings, see #633
3. Match folder node if searchLabel includes the filter query, see #646
4. New link directly into Tab, see #651
5. Resolve links to Panel titles, see #389, #401, and #659

1. Folder name starting with 1. creates raw HTML label in nav tree, see #650
2. Sidebar filter does not work for CamelCase titles, see #696
3. CI build process failing, see #708

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

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

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

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

1. Tree nav expanded state not saving

1. PRO 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

1. Update all client libraries

1. New Description List support

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

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 when in headings
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

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

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 (credits)
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

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

1. PRO New visibility: private and visibility: protected pages, see #341
2. New multi-language locale 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. New -n flag to prevent default web browser from being opened, see #323
6. New retype clean CLI command
7. New named regions with content, see #368
8. New {{ nonce }} token for cache busting URLs in templates, see #324
9. New Inter and system based font-family, see #179
10. New default Welcome page
11. New sticky TOC button
12. New context menu shortcuts for Retype components in Edit mode
13. New custom same name default page for a directory, see #511

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

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

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

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.

1. Support for full relative URL pathing. See #14, #133, #194, #222, #233, and #276.
2. New generator.paths project config with source, relative, root options.
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 generator.directoryIndex.altNames project config.
6. New RETYPE_DEFAULT_HOST environment variable. See #239.
7. New self-referential canonical meta tag for all pages.
8. Link to API pages using fully qualified class name path.

1. Exclude all contents of the _includes directory from being deployed.
2. Exclude files and pages within the _includes directory from the sitemap generation.
3. Sidebar menu item is not highlighted when missing trailing / in the URL.
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.

1. Switch generator.paths default value to relative.

To revert to the previous functionality, set the generator.paths config to root in your project retype.yml file.

generator:
  paths: root # Old default functionality

1. generator.recase project config to recase file and folder names. See #302.
2. Official Retype docker images published to DockerHub. See #122.
3. New @latest tag to be used in your retype-action.yml configuration.
4. GitHub Action annotation to announce availability of Retype v2, only if using Retype v1.

1. author, date, and category metadata being rendered above page title
2. top.md content should be excluded from summary card generation

1. Deploy .html and .htm files from input to output by default. See #302.
2. Apply generic attribute syntax to Retype generated <table> element.

1. Project include config not including pages if _* configured. See #296.

1. Redesign of Search results.
2. Page content live editor during retype start.
3. Project configuration for full, partial, and basic search index modes.
4. Content templating.
5. Disable templating on a page.
6. Line highlighting in code blocks.
7. ghost variant on Button, Badge, and Callout.
8. Custom site-wide includes for <head>, <body>, top.md, and bottom.md.
9. Support for custom generic attributes on Markdown components.
10. Support for adding images above the top h1 page heading.
11. Google Tag Manager integration.
12. Plausible IO integration.
13. Page limit handling has been improved during retype start mode.
14. Include description in search index.

1. Unable to scroll sidebar when navigating to a collapsed clickable sidebar menu. See #128.
2. Double-quote in image caption is not encoded. See #245.
3. Build fails if root retype.yml configuration file is blank. See #257.
4. Super mega long word in page title causes rendering issue. See #253.
5. Prevent float elements from interacting with Previous|Next buttons. See #232.
6. Unreliable sidebar and Prev/Next button label word wrapping. See #253.
7. Full width Callout component content. See #242.
8. Strange link resolution WARNING on emphasized markdown links. See #291.

1. allowFullScreen attribute on the [!embed] component.

1. Badges configured without a link [!badge x] are being ignored.
2. Horizontal scroll issue with wide table. See #192.
3. Relax client integrity verification rules. See #225 and #226.
4. Corrupted website config error appears on first load after rebuild. See #212 and #226.

1. Multi-language search and automatic detection of content languages. See #197.
2. Retype Pro with increased page limit and Retype branding removal option.
3. Better style for native scrollbars on Windows. See #107.
4. serve.start.validation project configuration option.
5. All heading elements within the page content are now added to the search index. See #166.
6. Page config and SUMMARY.md can be used together.
7. Upgrade Octicons icons library from v15.2.0 to v16.1.1.

1. \KaTeX math typesetting library support.
2. Auto generate RSS feed for blog posts.
3. serve.start.polling project option.
4. Gravatar support for author avatars.
5. project option to configure a default Gravatar image.
6. target and icon attributes on [!ref] component.
7. Smarter link resolution logic.

1. Incremental build during retype start with page dependency graph
2. Ability to run retype start with in-memory output. Turned on by default, see serve.start.mode to configure.
3. Platform specific NPM packages:
4. retypeapp-win-x86
5. retypeapp-win-x64
6. retypeapp-linux-x64
7. retypeapp-darwin-x64
8. Lazy Prism and Mermaid plugin execution for hidden content
9. Keep scroll position on full page reload during retype start.
10. Build is so fast now that the client refresh interval can be tightened up to 100ms.
11. Add target property for linkable components, such as Button and Badge.

1. Update expired NPM Access Token to fix broken NPM package publishing from v1.8.1.

1. Add broader checks for unresolved links, see #112. For instance, if a link to ../components is created, Retype will now try to resolve the path to any of the following:

../components.md
../components/index.md
../components/components.md
../components/default.md

1. Allow inline Markdown components for author, title, and label page configs, see #114. Block-level Markdown components will be ignored for those configs.

1. retype.yml project configuration file format.
2. url project config for setting your website URL.
3. Auto-generate a sitemap.xml file to inform search engines which pages to crawl.
4. Auto-generate a robots.txt file.
5. Open Graph and Twitter meta tags generated for every page.
6. serve.host and serve.port project configs.
7. /blog summary for any .md page added to a /blog folder.
8. author, category, and date page configs.
9. redirect page config.
10. visibility page config.
11. Added logic to handle the manual creation of a CNAME file and copy to output.
12. Automated process to check for new Octicons release and merge update.
13. Update to latest Octicons icon release.
14. Cleaned up the CLI experience. See #103.
15. Removed excessive bottom padding on blockquotes, see #74.

1. Column component.
2. Stacking Panels component.
3. Open Graph and Twitter card support.
4. Mermaid diagram and visualization support.
5. target config for all links within retype.yml.
6. Default page support for default.md.
7. Hover style on Badge component when links.
8. Super improved handling of áccënt characters.

1. tags config for pages.
2. :icon-shortcode: component.
3. include project config.
4. exclude project config.
5. Improved <table> styling.
6. Performance boost for components.

1. Badge component
2. Syntax highlighting support for all code block languages
3. route page config
4. port project config
5. Larger font-size for h1, h2, and h3 headers.
6. Better handing of special characters within file names.
7. Cleaner handling of .md pages created by GitHub Wiki.

1. Even cleaner upgrade to Retype from GitBook experience
2. Super fast retype start incremental build process
3. image alignment and captions
4. exclude config for retype.yml
5. blog layout and /blog folder defaults
6. [!file] component
7. [!ref] component

1. GitHub Actions for Retype.
2. expanded config on folder configuration.
3. icon and iconAlign configs on links.

1. central layout.
2. page layout.
3. Edit this page link.
4. Previous | Next footer navigation buttons for pages.
5. order Page level config.
6. hidden visibility Page level config.
7. favicon Project config available in retype.yml.

1. Tab component.
2. Button component.
3. Panel component with expand/collapse.
4. retype start command.
5. Live Reload when using retype start.
6. .yml option for Page or Folder configs.
7. Code Block title.
8. line numbering in code blocks.

1. Publish to NPM
2. Publish to NuGet
3. Initial v1.0.0 release