Release Version 1.0+

List of latest changes and updates on DocuBook

Version History:

This changelog contains a list of all the changes made to the DocuBook template. It will be updated with each new release and will include information about new features, bug fixes, and other improvements.

version 1.16.1

v1.16.1
August 12, 2025

Icon mapping, code block titles, and code block improvements

Added
    • icon mapping based on language
    • added handleCodeTitles function to generate pre block titles
Improved
    • adjusted the rehypeCodeTitles function
    • adjustments for CSS code block

In this update, you can see the differences in the images below.

code block old

code block old

version 1.16.0

v1.16.0
August 10, 2025

Accordion context, AccordionGroup component, and improved UI styling

Added
    • AccordionGroupContext to enable grouped accordion behavior
    • Add AccordionGroup component to markdown
Fixed
    • Adjust hover and background colors for improved visual consistency
Improved
    • Update styling to differentiate standalone and grouped accordions

version 1.15.3

v1.15.3
August 10, 2025

feat(accordion): add icon support and update styling

Added
    • Added optional icon prop to Accordion component using lucide-react icons
    • add docu.schema.json
Fixed
    • improve className and adjusted styling classes
Removed
    • Removed unused className prop

version 1.15.1

v1.15.1
August 6, 2025

Algolia DocSearch for better search result

Added
    • new DocSearch.tsx components
    • add props type algolia
    • add searchprops
    • add algolia.css
environment:

To use Algolia DocSearch, you need to configure the following environment variables:

NEXT_PUBLIC_ALGOLIA_DOCSEARCH_APP_ID="your_app_id"
NEXT_PUBLIC_ALGOLIA_DOCSEARCH_API_KEY="your_api_key"
NEXT_PUBLIC_ALGOLIA_DOCSEARCH_INDEX_NAME="your_index_name"

in the navbar component, add a prop to the class

Change <Search /> to <Search type="algolia" />

version 1.14.2

v1.14.2
August 5, 2025

Refactor & Fix: Decouple Search Component and Resolve Type Errors

Added
    • Refactor Search component into three distinct components: Search, SearchTrigger, and SearchModal for better maintainability and scalability.
    • New SearchTrigger components
    • New SearchModal components
Fixed
    • Resolve TypeScript error for missing 'noLink' property on the 'Page' type after refactoring.
    • Fix TypeScript error for missing 'context' property by providing a complete inline type annotation in the SearchModal component.

version 1.14.0

v1.14.0
August 2, 2025

Dev: Add workflow to run Sync NPM package

Added
    • Add workflows to run Sync NPM package
    • Add sync-from-npm.yml
    • Add PR to organization github.com/DocuBook/docubook

version 1.13.9

v1.13.9
July 27, 2025

Code Cleanup & Stability Improvements

Added
    • Added proper type definitions for unist-util-visit
    • Added .eslintrc.json configuration file
    • Added proper type checking for node values in markdown processing
Improved
    • Enhanced type safety in lib/markdown.ts with proper TypeScript interfaces
    • Converted interface extensions to type aliases in UI components for consistency
    • Improved code organization across multiple files
Fixed
    • Fixed potential null reference in markdown.ts when processing code blocks
    • Updated import for MDXRemote in mdx-provider.tsx
    • Optimized event listener cleanup in toc-observer.tsx
Removed
    • Removed unused state and variables in toc-observer.tsx
    • Removed unused imports for cleaner codebase

version 1.13.6

v1.13.6
June 1, 2025

Improve sheet leftbar and search icon

Improved
    • Improve sheet leftbar and search icon
    • color scheme for sheet leftbar
    • color scheme for search icon

version 1.13.5

v1.13.5
May 31, 2025

Add Theme schema for consistent theme

Added
    • Add Theme schema
    • Add Freshlime theme
    • Add Coffee theme
    • Add llms context for generated theme with AI
Improved
    • Markdown support for theme-colors
    • consistent theme-colors page
    • all components now consistent with theme-colors
    • syntax with theme-colors
Fixed
    • fix bug FileTree component
    • fix issue markdown with theme-colors

version 1.13.0

v1.13.0
May 29, 2025

Context Menu for organize file and folder

Added
    • New ContextMenu component for organizing file and folder
    • Nested docs folder and file support with context menu
Improved
    • improve routes-config with context menu
    • improve docu.json with context menu
    • improve leftbar with context menu
    • improve docs-menu with context menu
    • improve search dialog limit result to 6 post per suggestion
    • improve search result typing 3 characters to show suggestion

version 1.12.0

v1.12.0
May 28, 2025

New File Tree Component and enhancements for existing components or features

Added
    • New FileTree component for displaying hierarchical file structures
    • Support for nested folders and files with expand/collapse functionality
    • Hover effects showing file extensions
    • Dark mode support with modern styling
    • Keyboard navigation and accessibility features
    • add toc-observer data attribute to detect toc section
    • cli to copy from path npm registry
Improved
    • search dialog hover effect return key
    • search icon showing on mobile screens
Fixed
    • fix search dialog on mobile screens
    • fix release note component eslint error on mdx when rendering
    • fix mob-toc callback function
    • fix toc height issue when toc section is longer than screen height
Removed
    • remove prompts depedencies
    • remove degit depedencies
    • remove prompts functions
    • remove degit functions
    • remove prompts and degit from package.json
    • remove clone repository using git
Note:

on this version 1.12.0, we remove clone repository using git and replace it with cli to copy from path npm registry

version 1.11.0

v1.11.0
May 25, 2025

New Release Note components support multiple products or multiple changelogs

Added
    • New ReleaseNote component for structured changelog display
    • Added support for categorized changes (added, fixed, improved, deprecated, removed)
    • Integrated Lucide icons for better visual hierarchy
    • Support for multiple release notes
Improved
    • Enhanced documentation with comprehensive usage examples
    • Better component organization and styling
    • Semantic versioning support
    • Nested release notes support
Removed
    • Removed old changelog page in favor of the new ReleaseMdx component
    • Removed changelog.md
    • Removed changelog/page.tsx
    • Removed changelog.ts
    • Removed components/changelog

version 1.10.1

v1.10.1
May 24, 2025

Accessibility Improvements and Bug Fixes

Fixed
    • Added missing DialogDescription components for better accessibility
    • Fixed image aspect ratio issues in navbar logo
    • Resolved console warnings for missing image sizes
    • Improved keyboard navigation in search component
    • Fixed mobile layout for search result items
Improved
    • Added proper ARIA labels for screen readers
    • Enhanced focus management in dialogs
    • Optimized image loading with proper sizing attributes
    • Better mobile experience with responsive design fixes
Removed
    • Remove blog page
    • Remove blog functions on markdown

version 1.10.0

v1.10.0
May 21, 2025

Sidebar Improvements and Mobile TOC Enhancements

Added
    • New reusable ToggleButton component with animation
    • Mobile-friendly Table of Contents (TOC) component
    • Click-outside handler for better mobile navigation
    • Smooth scroll behavior for TOC navigation
    • Active section highlighting in TOC
Improved
    • Sidebar now has a collapsible design
    • Enhanced mobile responsiveness for TOC
    • Better visual hierarchy in sidebar navigation
    • Smoother animations for sidebar toggle
    • Optimized TOC performance with intersection observer
    • Improved accessibility with proper ARIA labels
    • Better spacing and alignment in mobile view
Fixed
    • Fixed sidebar toggle button positioning
    • Resolved TOC highlighting issues during scroll
    • Fixed z-index conflicts in mobile view
    • Addressed minor UI glitches in dark mode
    • Fixed TOC not updating on route changes
    • Resolved scroll jank on mobile devices
    • Fixed incorrect active state in navigation
Deprecated
    • No longer support changelog.md
    • No longer support changelog/page.tsx (will be removed in future update)

version 1.9.0

v1.9.0
May 19, 2025

New Keyboard component to show keyboard shortcut on docs page

Added
    • New Keyboard component with props show, type, children
    • Snippet keyboard component
Improved
    • Support custom content
    • Support platform type (mac or window)
    • Support automatic rendering of platform-specific key symbols
    • Rename lowercase to camelCase for markdown component

version 1.8.5

v1.8.5
May 10, 2025

Add sponsor card on single docs page

Added
    • Expandables Leftbar
    • Sponsor badges or ads
    • Boolean show/hide 'edit on github'
    • With the same code run anywhere (bun or nodejs)
    • Add frontmatter (metadata) to playground editor
Improved
    • Adjustment docu.json
    • Adjustment navbar, footer and components
Fixed
    • Bun compatibility: rename .js to common js
    • CLI manage packageManager on package.json
    • Inconsistent design moved to better UI/UX
    • Error handle render footer.social
Removed
    • Remove confusing and verbose CLI on installer

version 1.8.0

v1.8.0
March 1, 2025

Now looks more modern and clean which is a big change in layout and design

Added
    • Social footer
    • Toggle group
    • Site description in footer
    • Site title in footer
Improved
    • Header design changes
    • Footer design changes
    • New functions in theme provider
    • Object changes in docu.json
Fixed
    • Updates to path structure components
    • Groups to organize components

version 1.7.0

v1.7.0
February 23, 2025

Remove the old function in the search dialog and replace it with a new and more optimal feature

Added
    • Up and down navigation in search dialog
    • Enter (return) to select in search dialog
    • Escape to close the dialog
Improved
    • Maintenance for anchor components
    • Anchor.tsx adjustments for all elements that use it
Removed
    • Remove suboptimal search features

version 1.6.0

v1.6.0
February 21, 2025

New Feature Card Groups with arrays for more Flexible Content

Added
    • Card Groups Components
    • Props: href to url link
    • Props: horizontal boolean
Improved
    • Card props styling
    • Compatibility for Cards components
    • Support for children props in card content
Removed
    • Remove unused props cards components

version 1.5.0

v1.5.0
February 18, 2025

Minor Update - improved features and responsiveness on all devices

Added
    • New dialog footer on searchbox above medium screens
    • Icon X for close dialog on searchbox (ESC key on medium screen)
Improved
    • Responsive Leftbar components on large screens
    • Menu Trigger on medium screens
    • Responsive Navbar components on medium screens
    • Better UX for searchbox dialog
    • Tooltips components can be written together with regular paragraphs
Fixed
    • Responsive issues
    • Compatibility for Bun
    • Changes postcss.config.js to .cjs for Bun
    • All CLI installer and updater not working
    • Adjustments for package managers (npm, pnpm, bun, yarn)

version 1.4.2

v1.4.2
February 16, 2025

Complex Content for Accordion Component props children

Added
    • New Props with children in accordion
    • Compatibility for markdown in accordion
    • Nested components inside an accordion
    • New icon on note components
    • Add CLI npx @docubook/create@latest
    • Add CLI npx @docubook/update@latest
Improved
    • Better UI design for accordion
    • Styling Note components on markdown
    • Change accordion output on playground
    • Change accordion output on snippet
Removed
    • Remove deprecated props on accordion
    • Remove CLI npx update_docu
    • Remove CLI npx create_docu

version 1.4.0

v1.4.0
February 11, 2025

Floating Button Version with Dynamic Tag version on Changelog page

Added
    • New components / changelog floating-version.tsx
    • Button popover to open version-toc below large screens
    • Dynamic tag by section ID #version
    • Dynamic url tag #version
    • Dynamic version indicator on floating version when scrolling section by ID
Improved
    • Change icon version history
    • Responsive version-toc
    • Improvement components to changelog page

version 1.3.8

v1.3.8
February 8, 2025

Responsive Table of Content

Added
    • Components terminal MagicUI
    • Components card Shadcn
    • New mob-toc for a better experience on mobile devices
    • New Components scroll to top button
    • Scroll to top: blog-post
    • Scroll to top: docs-post
Improved
    • lib/markdown for generated dynamic toc on markdown
    • Responsive Table of Content below large screens
    • Improve docs page

version 1.3.6

v1.3.6
February 1, 2025

Appears more modern editor for Docu Play

Added
    • Line Number for editor
    • editor.css
Improved
    • Better Design for Editor
    • Similar to Github Editor
    • Moved Handler Element (copy, download, reset and fullscreen) on Header

version 1.3.5

v1.3.5
January 30, 2025

It's Easy to Write Markdown with Playground

Added
    • New Playground Page
    • New Playground Layout
    • Toolbar for Markdown Components
    • Fullscreen Mode to Focus Editing Your Content
    • Copy to Clipboard Your Content
    • Download Your Content as index.mdx
    • Reset Your Content without refresh the Browser
    • Only Large Screen for Better Experience

version 1.3.1

v1.3.1
January 20, 2025

Snippet Feature to Easily Write Markdown and Call DocuBook Components

Added
    • New Feature Snippet for Markdown Components
    • Support Snippet for Visual Studio Code
Removed
    • Remove props icon and props description for accordion components

version 1.3.0

v1.3.0
December 31, 2024

Release Note Feature to Make it Easier to Write Changelogs

Added
    • New Release Note Feature
    • New Layout for Changelog page
    • New Changelog page
    • Add Release Note Component
    • Easily write release notes directly from the CHANGELOG.md file
    • TOC for versioning
    • Write with the markdown tag
    • Add lib / changelog.ts
Improved
    • Improvement Responsive feature image for Version Entry
    • Improvement Layout for changelog page
    • Improvement Padding on mobile devices
    • Only use containers of md size
    • Improvement syntax.css for ul>li classes
Fixed
    • Fix og:image not showing on Page.tsx
    • Fix text-indent on class li
Removed
    • Remove excessive padding
    • Remove Logo on Footer

version 1.2.0

v1.2.0
December 22, 2024

New Accordion Component: Support content plain text, html and all markdown component

Added
    • Add New Accordion Component
Improved
    • Props Improvement
    • Support Dynamic Content for Accordion

version 1.1.0

v1.1.0
December 15, 2024

Minor Update: Easily manage set up with docu.json

Added
    • Add docu.json file
    • Add openGraph (title, description, image)
    • Add Dynamic metadata
    • Generate metadata as openGraph
    • OpenGraph support for .mdx
Improved
    • Routes-config from json
    • Frontmatter improvement
    • Edit the content of footer.tsx simply via the docu.json file
    • Edit the content of navbar.tsx simply via the docu.json file

version 1.0.7

v1.0.7
December 14, 2024

Easily updates your DocuBook Version with CLI npx update_docu

Added
    • CLI npx update_docu (update features into docubook existing directory)
    • Playground (easily to written content)
    • New Button component
    • Navbar external link conditions
    • CLI npx create_docu
Improved
    • Searchbar Improvement
    • Navigation Improvement
    • Edit on Github Improvement
Removed
    • Remove CLI npx create-docu (on this version not usage dash -)

version 1.0.6

v1.0.6
November 24, 2024

New Components, Fix and Improvement

Added
    • New Card component
    • New Tooltips component
Fixed
    • Change root folder
Improved
    • Logo on navbar & footer
    • Easily change logo

version 1.0.5

v1.0.5
November 16, 2024

Add New Features and Improvement for this version

Added
    • New Youtube component
    • Edit this page - easily manage directory content via the github repo
    • Support installation via CLI command npx create-docu
Improved
    • Keyboard shortcut command + k or ctrl + k to open search dialog

version 1.0.0

v1.0.0
November 10, 2024

Initial release of DocuBook to create interactive nested docs with MDX

Added
    • Initial release of DocuBook
    • Basic documentation structure
    • Markdown support with MDX
    • Responsive design
    • Search functionality
    • Dark mode support
Edit this page

Published on Aug 2, 2025