All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.
6.1.0 - 2024-01-06
- 🧰 Add support for redirecting via Express route syntax to help migrate away from Jekyll or other platforms
- 🧰 Export
asyncHandler
for use in plugins or other projects - 🛠 Remove need for
bind(this)
with class methods - 🛠 Clean up many types
- 🎁 Update dev dependencies
6.0.4 - 2023-12-25
- 🛠 Ensure
tags
are always sorted
6.0.3 - 2023-12-25
- 🛠 Fix types
6.0.2 - 2023-12-25
- 🛠 Fix lack of exports of
EJSRenderer
&DownloadRouter
6.0.1 - 2023-12-25
- 🧰 Add support for setting the
layout
on documents to determine the layout to render with - 🧰 Add
EJSRenderer
plugin for rendering EJS content in posts - 🧰 Add
DownloadRouter
plugin for allowing downloads withReferrer
checking - 🛠 Fix
AddQueryOutputToViewModel
plugin types
6.0.0 - 2023-12-22
- 💥 BREAKING CHANGES!
- 💥 Rename config key:
home_page
tohomePage
- 💥 Rename config key:
ignore_slugs
toignoreSlugs
- 💥 Rename config key:
home_page
toexcerptLength
- 💥 Rename config key:
excerpt_length
tohomePage
- 💥 Rename config key:
site_url
topublicUrl
- 💥 Rename config key:
theme_dir
tothemePath
- 💥 Rename config key:
public_dir
topublicPath
- 💥 Rename config key:
use_delete_key
touseDeleteKey
- 💥 Rename config key:
delete_key
todeleteKey
- 💥 Rename config key:
use_edit_key
touseEditKey
- 💥 Rename config key:
edit_key
toeditKey
- 💥 Rename config key:
public_history
topublicHistory
- 💥 Rename config key:
handle_not_found
tohandleNotFound
- 💥 Rename config key:
use_cache
touseCache
- 💥 Rename config key:
cache_short
tocacheShort
- 💥 Rename config key:
cache_long
tocacheLong
- 💥 Removed many configuration options that were not being used or items that should be theme specific:
site_title
,site_header
,site_footer
,site_sections
,site_locale
,site_twitter_site
,site_twitter_creator
,site_image
- 🧰 Add support for setting the
routes
for search & tags - 🧰 Add support for setting the
titles
for search & tags - 🧰 Added support for
allowCRUDRoutes
to disable the CRUD routes for a read-only wiki - 🧰 Added support for
ignoreTags
to ignore documents with specific tags - 🧰 Remove support for CommonJS, now requires ESM support
- Change the
detailRoute
route path matcher to/:slug*?
to allow for nested routes with the use of overridingdetailRoute
and handling therequest.params.slug
value accordingly` - 🎁 Update dependencies
- 🛠 Standardize types
- 🛠 Update ESLint configuration
- 🛠 Update documentation
5.2.2 - 2023-04-14
- 🛠 Overhaul types and fix some type related warnings.
- 🎁 Update dependencies
5.2.1 - 2023-04-13
- 🧹 Regenerate docs and readme with new updates.
- 🛠 Clean up some types that were outdated.
- 🛠 Clean up a
forEach
use that should have beenfor of
. - 🛠 Clean up an uneeded check of
document
.
5.2.0 - 2023-04-12
- 🧰 Add support for per route middleware through the configuration.
- 🎁 Update dependencies
5.1.0 - 2023-04-05
- 🧰 Add support for overriding route handlers.
- 🧰 Do not allow saving without content.
- 🧰 Expose session data to view models.
- 🎁 Update dependencies
5.0.3 - 2022-11-22
- 🪲 Creating new documents was not correctly checking for existing documents and showing an
undefined
flash message. - 🛠 Clean up some types that weren't as specific as they could be.
- 🎁 Update dependencies
5.0.2 - 2022-05-30
- 🧰 Add
production
configuration object, useful for development. - 🛠 Restoring history correctly renders the edit page.
- 🎁 Update dependencies
5.0.1 - 2022-05-22
- 🛠 Redirects will correctly handle line breaks when submitting form a form.
- 🎁 Update dependencies
5.0.0 - 2021-12-26
- 🧰 Change
POST
/PUT
routes to separate routes to separate creation from modification. - 🧰 Add flash message support when used with Express Session through
request.wikiFlash(key, value)
. - 🧰 Added
redirects
document option. Allows adding URLs to redirect to the current page. - 🛠 Added
use_cache
configuration option. EnablesCache-control
headers reducing server load, but breaks sessions. Cache is always disabled on the/edit
and/new
routes. Defaults totrue
. - 🛠 Added
handle_not_found
configuration option. Allows the middleware to capture fall through routes as a404 not found
handler when enabled. Defaults totrue
. - 🎁 Update dependencies
4.2.2 - 2021-11-28
- 🧰 Add Support for Open Graph images on documents
4.2.1 - 2021-11-28
- 🧰 Add Support for Open Graph images
4.2.0 - 2021-11-27
- 🧰 Add Support for previewing content
- 🛠 Use
cors
to help prevent spam - 🛠 Use
flatMap
rather than.map().flat()
- 🎁 Update dev dependencies
4.1.1 - 2021-01-30
- 🛠 Empty searches were missing the
searchResults
view model key rather than the expected array.
4.1.0 - 2021-01-21
- 🛠 Metadata was not being filtered without a document.
- 🛠 Remove unused proxy check.
4.0.0 - 2021-01-17
- 🧰 Add ESM Support
- 🧰 Add explicit exports
- 🧰 Remove EJS dependencies
- 🧰 Remove Ramda dependencies
- 🧰 Add support for
edit_key
andpublic_history
configuration for a blog like use case - 🧰 Add support for only saving defiend keys with
allowedDocumentKeys
- 🧰 Move cache times to config
- 🧹 Clean up some methods to be inline
- 🧹 Many small cleanup tasks around not using the root as the URL
- 🛠 Express Middleware configuration is now in the config
- 🛠 Use
COUNT(*)
for counts rather than fetches - 🎁 Update dev dependencies
3.4.2 - 2020-12-31
- 🧰 ESLint cleanup
- 🧰 Make
debug
an optional package - 🎁 Update dev dependencies
3.4.1 - 2020-11-15
- 🎁 Update dev dependencies
- 🎁 Update README badge URLs
- 🧰 Change how types are made and rebuild types
- 🧰 Created this file