roadmap.md

icon	versions

Roadmap

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

Need a new feature in Retype? Start a discussion and let's chat. 💬

v1.12.0 [!badge text="NEXT" variant="info"]

• New partials support
• New variables support
• New @region code block tags
• New line highlighting in code blocks
• New color palette option
• New hide left and right sidebar
• Any feature requests? Please let us know

v1.11.2 [!badge text="LATEST" variant="info"]

Released: 2021-12-23

• New allowFullScreen attribute on the [!embed] component.

v1.11.1

Released: 2021-12-02

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

v1.11.0

Released: 2021-11-19

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

v1.10.0

Released: 2021-09-30

• New $\KaTeX$ math typesetting library support
• New Auto generate RSS feed for blog posts
• New server.watch.polling project option
• New Gravatar support for author avatars
• New project option to configure a default Gravatar image
• New target and icon attributes on [!ref] component
• New smarter link resolution logic

v1.9.0

Released: 2021-08-30

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

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:

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

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

!!!warning

This release failed to run properly if the NPM package was installed. 🧐 We didn't notice that our NPM Access Token had expired between the v1.8.0 and v1.8.1 releases. The expired NPM token caused our automated release process to fail. Sorry about that. 😩 Once we figured out what was going wrong, a new NPM Access Token was set and v1.8.2 was released. We have added NPM token pre-checks and verifications to the automated release process to hopefully prevent the issue from ever happening again.

!!!

v1.8.0

Released: 2021-08-03

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

v1.7.0

Released: 2021-06-24

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

v1.6.0

Released: 2021-06-09

• New tags config for pages
• New :icon-shortcode: component
• New include project config
• New exclude project config
• Improved <table> styling
• Performance boost for components
• Dozens of enhancements, optimizations, and adjustments

v1.5.0

Released: 2021-05-12

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

v1.4.0

Released: 2021-04-12

• Even cleaner upgrade to Retype from GitBook experience
• New super fast retype watch incremental build process
• New image alignment and captions
• New exclude config for retype.yml
• New blog layout and /blog folder defaults
• New [!file] component
• New [!ref] component
• Many other minor enhancements and bug fixes

v1.3.0

Released: 2021-03-30

• New GitHub Actions for Retype
• New expanded config on folder configuration
• New icon and iconAlign configs on links
• Several important bug fixes

v1.2.0

Released: 2021-03-25

• New central layout
• New page layout
• New Edit this page link
• New Previous | Next footer navigation buttons for pages
• New order Page level config
• New ~~hidden visibility Page level config
• New favicon Project config available in retype.yml
• New beta release of building C# project reference documentation

v1.1.0

Released: 2021-03-12

• New Tab component
• New Button component
• New Panel component with expand/collapse
• New retype watch command
• New Live Reload when using retype watch
• New .yml option for Page or Folder configs
• New code block title
• Enable line numbering in code blocks

v1.0.0

Released: 2021-02-11

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