Powered by

#Changelog

The entire release archive of Retype is available on NPM or NuGet.

#v3.10.0 NEXT

In progress, expected late Q2 2025.

#v3.9.0 LATEST

Released: 2025-05-28

  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

#v3.8.0

Released: 2025-05-05

  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

#v3.7.0

Released: 2025-04-07

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

#v3.6.0

Released: 2024-09-17

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

#v3.5.0

Released: 2023-09-16

  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

#v3.4.0

Released: 2023-09-08

  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

s## v3.3.0

Released: 2023-08-31

  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

#v3.2.0

Released: 2023-08-23

  1. New Description List support

#v3.1.0

Released: 2023-07-23

  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

#v3.0.0

Released: 2023-05-29

  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

#v2.4.0

Released: 2022-07-14

  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.

#v2.3.0

Released: 2022-05-03

  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.

#v2.2.0

Released: 2022-03-30

  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.

#v2.1.0

Released: 2022-03-22

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

#v2.0.0

Released: 2022-03-14

  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.

#v1.11.2

Released: 2021-12-23

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

#v1.11.1

Released: 2021-12-02

  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.

#v1.11.0

Released: 2021-11-19

  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.

#v1.10.0

Released: 2021-09-30

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

#v1.9.0

Released: 2021-08-30

  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.

#v1.8.2

Released: 2021-08-06

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

#v1.8.1

Released: 2021-08-05

  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.

#v1.8.0

Released: 2021-08-03

  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.

#v1.7.0

Released: 2021-06-24

  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.

#v1.6.0

Released: 2021-06-09

  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.

#v1.5.0

Released: 2021-05-12

  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.

#v1.4.0

Released: 2021-04-12

  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

#v1.3.0

Released: 2021-03-30

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

#v1.2.0

Released: 2021-03-25

  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.

#v1.1.0

Released: 2021-03-12

  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.

#v1.0.0

Released: 2021-02-11

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