Skip to content

Commit 4e1bfec

Browse files
authored
Update documentation anchors for VitePress compatibility (#19221)
* Update documentation anchors for VitePress compatibility Update @link annotations in Hash.php and Text.php to use the new VitePress-compatible anchor format. The documentation book now uses VitePress which generates anchors differently from the old RST/Sphinx setup. Related: cakephp/docs#8157, cakephp/docs#8158 * Update additional documentation anchors for VitePress compatibility - FormHelper: use section heading anchor instead of Cake\ class path - Controller: use section heading anchor for redirect - HtmlHelper: fix programmatically typo to match docs heading - ServerCommand: fix page URL (console-and-shells β†’ console-commands/commands) - ConsoleIo: fix page URL (console-and-shells β†’ console-commands/input-output) - Debugger: use existing section heading anchor - TranslateBehavior: fix I18n locale anchor to match setLocale heading Ref cakephp/docs#8160 * Fix SecurityHeadersMiddleware link to dedicated docs page The middleware has its own page at security/security-headers instead of an anchor on the middleware page. * Fix pluginSplit anchor casing for VitePress VitePress lowercases all heading anchors, so pluginSplit() generates #pluginsplit not #pluginSplit. * Fix broken @link annotations and add missing doc links Fix 3 broken links: - FormHelper::year() anchor: #creating-year-inputs β†’ #creating-year-controls - Configure::load() anchor: #reading-and-writing-configuration-files β†’ #reading-writing-configuration-files - CookieCryptTrait: remove dead link (controllers/components/cookie.html returns 404) Add missing @link for documented methods: - Text: uuid, tokenize, insert, cleanInsert, wrap, wrapBlock, tail, transliterate, slug - HtmlHelper: linkFromPath (more specific anchor), media - ConsoleIo: out, err - Controller: loadComponent
1 parent a11c03c commit 4e1bfec

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

β€ŽMiddleware/SecurityHeadersMiddleware.phpβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
/**
2626
* Handles common security headers in a convenient way
2727
*
28-
* @link https://book.cakephp.org/5/en/controllers/middleware.html#security-header-middleware
28+
* @link https://book.cakephp.org/5/en/security/security-headers.html
2929
*/
3030
class SecurityHeadersMiddleware implements MiddlewareInterface
3131
{

0 commit comments

Comments
 (0)