# Roadmap

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

# v3.0.0 NEXT

Planned: Q1 2023

  • PRO New password protected Pages and Folders.
  • New Project level language targeting with 24 languages supported.
  • New named regions and referencing named regions within includes.
  • New meta.title page config for specifying a custom page <title>.
  • New {{nonce}} template token for a unique number value.
  • New unified API command names and features.
  • Update to latest Prism, Octicons, and Mermaid releases
  • Fixing misc defects and include several minor enhancements.

# v2.4.0 LATEST

Released: 2022-07-14

  1. generator.directoryIndex.append project config.
  2. generator.trailingSlash project config to instruct whether to add a trailing / when constructing links.
  3. 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.

# v2.3.0

Released: 2022-05-03

  • Support for full relative URL pathing. See #14, #133, #194, #222, #233, and #276.
  • New generator.paths project config with source, relative, root options.
  • New search.preload project config to instruct Retype to preload the search index instead of on demand load.
  • New generator.directoryIndex.name project config for setting the default document name.
  • New generator.directoryIndex.altNames project config.
  • New RETYPE_DEFAULT_HOST environment variable. See #239.
  • New self-referential canonical meta tag for all pages.
  • Link to API pages using fully qualified class name path.
  • Exclude all contents of the _includes directory from being deployed.
  • Exclude files and pages within the _includes directory from the sitemap generation.
  • Sidebar menu item is not highlighted when missing trailing / in the URL.
  • Editor font request does not respect base path. See #318.
  • Syntax errors in yaml files results in corrupt category URLs. See #316.
  • links to the index document in the mobile sidebar footer not being resolved.
  • .yml files excluded from deploy even if explicitly declared in include. See #311.
  • og:url and twitter:url paths incorrect for API generated pages.
  • Include full version in the generator meta tag version.
  • Many categories extends beyond page width and does not wrap. See #316.
  • 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.

  paths: root # Old default functionality

# v2.2.0

Released: 2022-03-30

  • generator.recase project config to recase file and folder names. See #302.
  • Official Retype docker images published to DockerHub. See #122.
  • New @latest tag to be used in your retype-action.yml configuration.
  • GitHub Action annotation to announce availability of Retype v2, only if using Retype v1.
  • author, date, and category metadata being rendered above page title
  • top.md content should be excluded from summary card generation

# v2.1.0

Released: 2022-03-22

  • Deploy .html and .htm files from input to output by default. See #302.
  • Apply generic attribute syntax to Retype generated <table> element.
  • Project include config not including pages if _* configured. See #296.

# v2.0.0

Released: 2022-03-14

  • Redesign of Search results.
  • Page content live editor during retype watch.
  • Project configuration for full, partial, and basic search index modes.
  • Content templating.
  • Disable templating on a page.
  • Line highlighting in code blocks.
  • ghost variant on Button, Badge, and Alert.
  • Custom site-wide includes for <head>, <body>, top.md, and bottom.md.
  • Support for custom generic attributes on Markdown components.
  • Support for adding images above the top h1 page heading.
  • Google Tag Manager integration.
  • Plausible IO integration.
  • Page limit handling has been improved during retype watch mode.
  • Include description in search index.
  • Unable to scroll sidebar when navigating to a collapsed clickable sidebar menu. See #128.
  • Double-quote in image caption is not encoded. See #245.
  • Build fails if root retype.yml configuration file is blank. See #257.
  • Super mega long word in page title causes rendering issue. See #253.
  • Prevent float elements from interacting with Previous|Next buttons. See #232.
  • Unreliable sidebar and Prev/Next button label word wrapping. See #253.
  • Full width Alert component content. See #242.
  • Strange link resolution WARNING on emphasized markdown links. See #291.

# v1.11.2

Released: 2021-12-23

# v1.11.1

Released: 2021-12-02

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

# v1.11.0

Released: 2021-11-19

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

# v1.10.0

Released: 2021-09-30

# v1.9.0

Released: 2021-08-30

# v1.8.2

Released: 2021-08-06

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

# v1.8.1

Released: 2021-08-05

  • 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:
  • 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

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

# v1.7.0

Released: 2021-06-24

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

# v1.6.0

Released: 2021-06-09

# v1.5.0

Released: 2021-05-12

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

# v1.4.0

Released: 2021-04-12

  • Even cleaner upgrade to Retype from GitBook experience
  • Super fast retype watch incremental build process
  • image alignment and captions
  • exclude config for retype.yml
  • blog layout and /blog folder defaults
  • [!file] component
  • [!ref] component

# v1.3.0

Released: 2021-03-30

# v1.2.0

Released: 2021-03-25

# v1.1.0

Released: 2021-03-12

# v1.0.0

Released: 2021-02-11

  • Publish to NPM
  • Publish to NuGet
  • Initial v1.0.0 release