#Changelog
The entire release archive of Retype is available on NPM or NuGet.
Need a new feature in Retype? Open an issue and let's chat.
#v3.6.0 LATEST
Released: 2024-09-17
#v3.5.0
Released: 2023-09-16
- New
--pro
flag duringretype start
to enable trial mode of Retype Pro features, see #612 - New
start.pro: true
project config to enable trial mode of Retype Pro features, see #612
#v3.4.0
Released: 2023-09-08
#v3.3.0
Released: 2023-08-31
#v3.2.0
Released: 2023-08-23
- New Description List support
#v3.1.0
Released: 2023-07-23
- PRO New
outbound
project config for outbound external link configuration, see #465 - PRO New folder level
visibility: private
andvisibility: protected
support - New support for Armenian, Kannada, Sankrit, and Telugu languages
- The _includes/*.html files include full Templating support, see #282
#v3.0.0
Released: 2023-05-29
- PRO New
visibility: private
andvisibility: protected
pages, see #341 - New multi-language
locale
interface support for 22 languages, see #18 and #24 - New
meta.title
page level config, see #346 and #350 - New CLI commands and flags, see #94 and #323
- New
-n
flag to prevent default web browser from being opened, see #323 - New
retype clean
CLI command - New named regions with content, see #368
- New
{{ nonce }}
token for cache busting URLs in templates, see #324 - New Inter and system based font-family, see #179
- New default Welcome page
- New sticky TOC button
- New context menu shortcuts for Retype components in Edit mode
- New custom same name default page for a directory, see #511
#v2.4.0
Released: 2022-07-14
#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 withsource
,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.
#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.
#v2.1.0
Released: 2022-03-22
#v2.0.0
Released: 2022-03-14
- Redesign of Search results.
- Page content live editor during
retype start
. - Project configuration for
full
,partial
, andbasic
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
, andbottom.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 start
mode. - Include
description
in search index.
#v1.11.2
Released: 2021-12-23
-
allowFullScreen
attribute on the[!embed]
component.
#v1.11.1
Released: 2021-12-02
#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.
-
serve.start.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
- Incremental build during
retype start
with page dependency graph - Ability to run
retype start
with in-memory output. Turned on by default, seeserve.start.mode
to configure. - Platform specific NPM packages:
- Lazy Prism and Mermaid plugin execution for hidden content
- Keep scroll position on full page reload during
retype start
. - 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
#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:
#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.
-
serve.host
andserve.port
project configs. -
/blog
summary for any .md page added to a/blog
folder. -
author
,category
, anddate
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
#v1.6.0
Released: 2021-06-09
-
tags
config for pages. -
:icon-shortcode:
component. -
include
project config. -
exclude
project config. - Improved
<table>
styling. - Performance boost for components.
#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
, andh3
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 start
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
-
central
layout. -
page
layout. -
Edit this page
link. -
Previous | Next
footer navigation buttons for pages. -
order
Page level config. -
hidden
visibility
Page level config. -
favicon
Project config available in retype.yml.
#v1.1.0
Released: 2021-03-12
- Tab component.
- Button component.
- Panel component with expand/collapse.
-
retype start
command. - Live Reload when using
retype start
. - .yml option for Page or Folder configs.
- Code Block title.
- line numbering in code blocks.
#v1.0.0
Released: 2021-02-11
- Publish to NPM
- Publish to NuGet
- Initial
v1.0.0
release