Version 2.3.0-preview

Version 2.3.0-preview

There were 16 changes in Retype 2.3.0-preview.

New

1. Full relative URL pathing support. See #14, #133, #163, #184, #194, #222, #233, #239, #276.
2. trailingSlash project config to instruct whether to add a trailing / when constructing links.
3. New preload project config to instruct Retype to preload the search index instead of on demand load.
4. New directoryIndex.name project config for setting the default document name.
5. New generator.directoryIndex.append project config.
6. Switch generator.paths default value to relative.
7. New RETYPE_DEFAULT_HOST environment variable. See #239.
8. New self-referential canonical tag for all pages.

Fixed

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

Version 2.2.0

Version 2.2.0

There were 5 changes in Retype 2.2.0.

New

1. Official Retype docker images at DockerHub's retypeapp/retype repository. See #122.
2. New generator.recase project config to instruct Retype on when to recase file and folder names. See #302.

Improved

1. Add GitHub Action annotation to announce availability of Retype v2.

Fixed

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

Version 2.1.0

There were 7 changes in Retype 2.1.0.

New

1. By default, deploy .html and .htm files from input to output.

Improved

1. Apply generic attribute syntax to Retype generated <table> element.

Fixed

1. Project include is not including _* pages. See #296.
2. Edit button being rendered on generated pages that cannot be edited.
3. Double addition of url base in og:image and twitter:image path.
4. Page hangs when [object Object] within content.
5. Wallet with key(s) prevents retype watch on new projects.

Version 2.0.0

Version 2.0.0

There were 51 changes in Retype 2.0.0.

New

1. Content templating support with includes, variables, and logic operators. See #213.
2. Page content live editor.
3. Ability to enable/disable templating per page.
4. Support line ranges for partial content.
5. Line highlighting in code blocks. See #176.
6. Custom <script> or <style> blocks within a page. See #255.
7. Google TagManager integration. See #234.
8. Plausible.io integration. See #272.
9. Allow img and alerts above h1 heading.
10. Improved maximum page limit handling.
11. If page level title config and no top level h1, inject the title as the top most element.
12. Magic site-wide includes. See #272.
13. Allow generic attributes for Markdown native elements. See #278.
14. New ghost variant for Button, Badge, and Alert components.
15. Include page description in search index and results. See #59.
16. New search index mode with full, partial, and basic options.
17. Complete redesign of Search results. See #59.
18. Configuration to enable|disable live editor.

Improved

1. Highlight search input query in search results.
2. Improved collapse-on-click for left sidebar folder when there is a default page. See #128.
3. Add README to Yarn and NPM package directories.
4. Remove deleted items from output when in memory watch mode.
5. Upgrade Octicons icons library from v16.1.1 to v16.2.0.
6. Ability to include .yaml files as resources.
7. Upgrade Octicons icons library from v16.2.0 to v16.3.0.
8. Improvement to ToC highlight tracking. See #41, #134.
9. Revise wallet path to .retype/license.dat. See #262.
10. Migrate to .NET 6.
11. Upgrade Octicons icons library from v16.3.0 to v16.3.1.
12. Improved link resolution of relative URLs.
13. Slight font-size increase on h1 and h2.
14. Adjustments to layout widths and resize breakpoints. See #57.
15. Hide ToC Contents heading if no inner page sub-headings.
16. Upgrade Octicons icons library from v16.3.1 to v17.0.0.

Fixed

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. Angle brackets are not rendered in the Sidebar.
7. Mustache template syntax is not being escaped.
8. Unreliable sidebar and Prev/Next button label word wrapping. See #253.
9. Scroll position is not being maintained in retype watch.
10. route not respected if configured on a folder more than one level higher.
11. Full width Alert component content. See #242.
12. API Generation of C# Namespaces converts the CamelCase names to all lowercase except the first letter. See #277.
13. Strange link resolution WARNING on emphasized markdown links. See #291.
14. Trim heading anchors of whitespace before creating anchor value.
15. File component not resolving paths if path to a .md file.
16. Conditional resources are not written to output on incremental builds.

Breaking Changes

1. Pages with redirect config to be visible by default in main sidebar navigation. See #236.

v2.0.0-preview

Version 2.0.0-preview

There were 46 changes in Retype 2.0.0-preview.

New

1. Content templating support with includes, variables, and logic operators. See #213.
2. Page content live editor.
3. Ability to enable/disable templating per page.
4. Support line ranges for partial content.
5. Line highlighting in code blocks. See #176.
6. Custom <script> or <style> blocks within a page. See #255.
7. Google TagManager integration. See #234.
8. Plausible.io integration. See #272.
9. Allow img and alerts above h1 heading.
10. Improved maximum page limit handling.
11. If page level title config and no top level h1, inject the title as the top most element.
12. Magic site-wide includes. See #272.
13. Allow generic attributes for Markdown native elements. See #278.
14. New ghost variant for Button, Badge, and Alert components.
15. Include page description in search index and results. See #59.
16. New search index mode with full, partial, and basic` options.
17. Complete redesign of Search results. See #59.

Improved

1. Highlight search input query in search results.
2. Improved collapse-on-click for left sidebar folder when there is a default page. See #128.
3. Add README to Yarn and NPM package directories.
4. Remove deleted items from output when in memory watch mode.
5. Ability to include .yaml files as resources.
6. Improvement to ToC highlight tracking. See #41, #134.
7. Revise wallet path to .retype/license.dat. See #262.
8. Migrate to .NET 6.
9. Improved link resolution of relative URLs.
10. Slight font-size increase on h1 and h2.
11. Adjustments to layout widths and resize breakpoints. See #57.
12. Hide ToC Contents heading if no inner page sub-headings.
13. Upgrade Octicons icons library from v16.1.1 to v17.0.0.

Fixed

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. Angle brackets are not rendered in the Sidebar.
7. Mustache template syntax is not being escaped.
8. Unreliable sidebar and Prev/Next button label word wrapping. See #253.
9. Scroll position is not being maintained in retype watch.
10. route not respected if configured on a folder more than one level higher.
11. Full width Alert component content. See #242.
12. API Generation of C# Namespaces converts the CamelCase names to all lowercase except the first letter. See #277.

Breaking Changes

1. Pages with redirect config to be visible by default in main sidebar navigation. See #236.

Version 1.11.2

Version 1.11.2

There were 1 change in Retype 1.11.2.

New

• Add allowFullScreen=true|false attribute to embed component.

Version 1.11.1

There were 4 changes in Retype 1.11.1.

Fixed

• Badges without links syntax [!badge x] are ignored.
• Relax client integrity verification rules. See #225, #226.
• Corrupted website configuration error appears on first load after rebuild. See #212, #226.
• Bug with long table. See #192.

Version 1.11.0

Version 1.11.0

There were 22 changes in Retype 1.11.0.

New

• Local URLs with anchors resolved and validated during build.
• Large resource files not copied to the in-memory output and to use local file reference.
• New server.watch.validation project configuration option.
• icon config in yml supported if SUMMARY.md used.
• New style for native scrollbar styles on Windows. See #107.
• Upgrade Octicons icons library from v15.2.0 to v16.0.0.
• All heading elements within the page content added to the search index. See #166.
• Support smooth scrolling anchor links on Button and Badge components.
• Page config and SUMMARY.md can be used together.
• Update all client dependency packages to latest.
• Upgrade Octicons icons library from v16.0.0 to v16.1.1.
• Ability to highlight Mermaid syntax in code blocks. See #200.
• Retype Pro license implementation.
• Multilingual search and automatic detection of content languages. See #197.
• search.minChars default revised to 2 chars. See #206.
• Ignore faulty configuration values gracefully.

Fixed

• Retype build interpreter exception on a specific markdown email pattern. See #110.
• Retype's anchor and side bars (left/right) links ignores browser ctrl modifier key. See #118.
• Trailing slashes are not respected with CRLF. See #167.
• retype watch exception when .md file is in use by another process.
• Fixes typo with "supersede" word when page config source conflict is identified.
• Search box skeleton placeholder text different than search.placeholder project config.

v1.10.0

Version 1.10.0

There were 13 changes in Retype 1.10.0.

New

• New KaTeX math typesetting library support. See #73, #139.
• Revise link resolution rules.
• Upgrades Octicons from v15.0.1 to v15.2.0.
• Auto generate RSS feed for blog.
• New server.watch.polling configuration option. See #151.
• Gravatar support for avatar. See #141.
• Gravatar: ability to disable and choose default image. See #141.
• Support target and icon attributes in [!ref] components. See #158.

Fixed

• In-memory output can be logged with retype build.
• Blog summary page cards not updated in retype watch .
• Fix support for 32-bit NodeJS installs. See #146.
• Revise component label parsing.
• Windows-like numerical ordering of the sidebar items.

v1.10.0-preview

Version 1.10.0-preview

There were 9 changes in Retype 1.10.0-preview.

This is a pre-release! Can you help us check if what we fixed and implemented really works? Any feedback is welcome!

New

• New KaTeX math typesetting library support. See #73, #139.
• Revise link resolution rules.
• Upgrades Octicons from v15.0.1 to v15.2.0.
• Auto generate RSS files for Blog Post pages.
• New server.watch.polling configuration option.

Fixed

• In-memory output can be logged with retype build.
• Blog summary page cards are not updated in retype watch .
• Fix support for 32-bit NodeJS installs. See #146.
• Revise component label parsing.