website(docs): Add default layout property (#3705)

rome · Nov 13, 2022 · d2d0b77 · d2d0b77
1 parent b232fe3
commit d2d0b77
Show file tree

Hide file tree

Showing 78 changed files with 17 additions and 86 deletions.
diff --git a/website/astro.config.ts b/website/astro.config.ts
@@ -142,6 +142,13 @@ function inlineIntegration(): AstroIntegration {
 	};
 }
 
+function remarkDefaultLayoutPlugin() {
+  return function (tree, file) {
+		const {frontmatter} = file.data.astro;
+    frontmatter.layout = frontmatter.layout ?? "/Layout.astro";
+  };
+}
+
 // https://astro.build/config
 export default defineConfig({
 	site: "https://rome.tools",
@@ -163,7 +170,7 @@ export default defineConfig({
 
 	markdown: {
 		syntaxHighlight: "prism",
-		remarkPlugins: [remarkToc],
+		remarkPlugins: [remarkToc, remarkDefaultLayoutPlugin],
 		rehypePlugins: [
 			rehypeSlug,
 			[

diff --git a/website/src/components/NavigationSidebar.astro b/website/src/components/NavigationSidebar.astro
@@ -1,9 +1,9 @@
 ---
 import ExternalLinks from "./ExternalLinks.astro";
 import ActiveLink from "./ActiveLink.astro";
-import navigation from "../navigation.json";
+import navigation from "/navigation.json";
 
-import {buildGetPages, buildTOC} from "../navigation-utils";
+import {buildGetPages, buildTOC} from "/navigation-utils";
 
 const {props} = Astro;
 const {frontmatter = {}} = props;

diff --git a/website/src/pages/cli.mdx b/website/src/pages/cli.mdx
@@ -1,5 +1,4 @@
 ---
-layout: ../Layout.astro
 title: CLI
 emoji: ⌨️
 category: reference

diff --git a/website/src/pages/configuration.mdx b/website/src/pages/configuration.mdx
@@ -3,10 +3,9 @@ title: Configuration
 emoji: ⚙️
 category: reference
 description: How to customize and configure Rome with rome.json.
-layout: ../Layout.astro
 ---
 
-import LintGroups from "../components/reference/Groups.astro";
+import LintGroups from "/components/reference/Groups.astro";
 
 {/** Make sure to update the redirect in `static/_redirects` when changing the configuration title --> **/}
 

diff --git a/website/src/pages/credits.mdx b/website/src/pages/credits.mdx
@@ -3,10 +3,9 @@ title: Credits
 emoji: 📝
 description: Previous contributors and acknowledgments for projects that inspire us.
 category: internals
-layout: ../Layout.astro
 ---
 
-import Contributors from "../components/Contributors.astro";
+import Contributors from "/components/Contributors.astro";
 
 # Credits
 

diff --git a/website/src/pages/formatter/index.mdx b/website/src/pages/formatter/index.mdx
@@ -3,10 +3,9 @@ title: Formatter
 emoji: 🖌️
 category: tools
 description: How to use the Rome formatter.
-layout: ../../Layout.astro
 ---
 
-import PackageManagerRomeCommand from "../../components/PackageManagerRomeCommand.astro";
+import PackageManagerRomeCommand from "/components/PackageManagerRomeCommand.astro";
 
 # Formatter
 

diff --git a/website/src/pages/guides/getting-started.mdx b/website/src/pages/guides/getting-started.mdx
@@ -1,5 +1,4 @@
 ---
-layout: /Layout.astro
 title: Getting Started
 category: guides
 emoji: 🎉

diff --git a/website/src/pages/internals/architecture.mdx b/website/src/pages/internals/architecture.mdx
@@ -3,7 +3,6 @@ title: Architecture
 emoji: 🏛️
 category: internals
 description: How Rome works.
-layout: ../../Layout.astro
 ---
 
 # Architecture (in progress)

diff --git a/website/src/pages/internals/index.mdx b/website/src/pages/internals/index.mdx
@@ -1,4 +1,3 @@
 ---
 title: Internals
-layout: ../../Layout.astro
 ---
diff --git a/website/src/pages/internals/philosophy.mdx b/website/src/pages/internals/philosophy.mdx
@@ -3,7 +3,6 @@ title: Philosophy
 emoji: 🧐
 category: internals
 description: How we think about building Rome.
-layout: ../../Layout.astro
 ---
 
 # Philosophy

diff --git a/website/src/pages/lint/rules/index.mdx b/website/src/pages/lint/rules/index.mdx
@@ -1,6 +1,5 @@
 ---
 title: Lint Rules
-layout: ../../../Layout.astro
 emoji: 📏
 description: List of available lint rules.
 category: reference

diff --git a/website/src/pages/lint/rules/noArguments.md b/website/src/pages/lint/rules/noArguments.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noArguments
-layout: ../../../Layout.astro
 ---
 
 # noArguments (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noArrayIndexKey.md b/website/src/pages/lint/rules/noArrayIndexKey.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noArrayIndexKey
-layout: ../../../Layout.astro
 ---
 
 # noArrayIndexKey (since v0.10.0)

diff --git a/website/src/pages/lint/rules/noAsyncPromiseExecutor.md b/website/src/pages/lint/rules/noAsyncPromiseExecutor.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noAsyncPromiseExecutor
-layout: ../../../Layout.astro
 ---
 
 # noAsyncPromiseExecutor (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noAutofocus.md b/website/src/pages/lint/rules/noAutofocus.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noAutofocus
-layout: ../../../Layout.astro
 ---
 
 # noAutofocus (since v10.0.0)

diff --git a/website/src/pages/lint/rules/noBannedTypes.md b/website/src/pages/lint/rules/noBannedTypes.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noBannedTypes
-layout: ../../../Layout.astro
 ---
 
 # noBannedTypes (since v10.0.0)

diff --git a/website/src/pages/lint/rules/noCatchAssign.md b/website/src/pages/lint/rules/noCatchAssign.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noCatchAssign
-layout: ../../../Layout.astro
 ---
 
 # noCatchAssign (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noChildrenProp.md b/website/src/pages/lint/rules/noChildrenProp.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noChildrenProp
-layout: ../../../Layout.astro
 ---
 
 # noChildrenProp (since v0.10.0)

diff --git a/website/src/pages/lint/rules/noCommentText.md b/website/src/pages/lint/rules/noCommentText.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noCommentText
-layout: ../../../Layout.astro
 ---
 
 # noCommentText (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noCompareNegZero.md b/website/src/pages/lint/rules/noCompareNegZero.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noCompareNegZero
-layout: ../../../Layout.astro
 ---
 
 # noCompareNegZero (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noConstAssign.md b/website/src/pages/lint/rules/noConstAssign.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noConstAssign
-layout: ../../../Layout.astro
 ---
 
 # noConstAssign (since v10.0.0)

diff --git a/website/src/pages/lint/rules/noDangerouslySetInnerHtml.md b/website/src/pages/lint/rules/noDangerouslySetInnerHtml.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noDangerouslySetInnerHtml
-layout: ../../../Layout.astro
 ---
 
 # noDangerouslySetInnerHtml (since v0.10.0)

diff --git a/website/src/pages/lint/rules/noDangerouslySetInnerHtmlWithChildren.md b/website/src/pages/lint/rules/noDangerouslySetInnerHtmlWithChildren.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noDangerouslySetInnerHtmlWithChildren
-layout: ../../../Layout.astro
 ---
 
 # noDangerouslySetInnerHtmlWithChildren (since v0.10.0)

diff --git a/website/src/pages/lint/rules/noDebugger.md b/website/src/pages/lint/rules/noDebugger.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noDebugger
-layout: ../../../Layout.astro
 ---
 
 # noDebugger (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noDelete.md b/website/src/pages/lint/rules/noDelete.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noDelete
-layout: ../../../Layout.astro
 ---
 
 # noDelete (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noDoubleEquals.md b/website/src/pages/lint/rules/noDoubleEquals.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noDoubleEquals
-layout: ../../../Layout.astro
 ---
 
 # noDoubleEquals (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noDupeArgs.md b/website/src/pages/lint/rules/noDupeArgs.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noDupeArgs
-layout: ../../../Layout.astro
 ---
 
 # noDupeArgs (since v0.9.0)

diff --git a/website/src/pages/lint/rules/noEmptyPattern.md b/website/src/pages/lint/rules/noEmptyPattern.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noEmptyPattern
-layout: ../../../Layout.astro
 ---
 
 # noEmptyPattern (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noExplicitAny.md b/website/src/pages/lint/rules/noExplicitAny.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noExplicitAny
-layout: ../../../Layout.astro
 ---
 
 # noExplicitAny (since v10.0.0)

diff --git a/website/src/pages/lint/rules/noExtraBooleanCast.md b/website/src/pages/lint/rules/noExtraBooleanCast.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noExtraBooleanCast
-layout: ../../../Layout.astro
 ---
 
 # noExtraBooleanCast (since v0.9.0)

diff --git a/website/src/pages/lint/rules/noFunctionAssign.md b/website/src/pages/lint/rules/noFunctionAssign.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noFunctionAssign
-layout: ../../../Layout.astro
 ---
 
 # noFunctionAssign (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noImplicitBoolean.md b/website/src/pages/lint/rules/noImplicitBoolean.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noImplicitBoolean
-layout: ../../../Layout.astro
 ---
 
 # noImplicitBoolean (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noImportAssign.md b/website/src/pages/lint/rules/noImportAssign.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noImportAssign
-layout: ../../../Layout.astro
 ---
 
 # noImportAssign (since v0.9.0)

diff --git a/website/src/pages/lint/rules/noInvalidConstructorSuper.md b/website/src/pages/lint/rules/noInvalidConstructorSuper.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noInvalidConstructorSuper
-layout: ../../../Layout.astro
 ---
 
 # noInvalidConstructorSuper (since v10.0.0)

diff --git a/website/src/pages/lint/rules/noLabelVar.md b/website/src/pages/lint/rules/noLabelVar.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noLabelVar
-layout: ../../../Layout.astro
 ---
 
 # noLabelVar (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noMultipleSpacesInRegularExpressionLiterals.md b/website/src/pages/lint/rules/noMultipleSpacesInRegularExpressionLiterals.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noMultipleSpacesInRegularExpressionLiterals
-layout: ../../../Layout.astro
 ---
 
 # noMultipleSpacesInRegularExpressionLiterals (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noNegationElse.md b/website/src/pages/lint/rules/noNegationElse.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noNegationElse
-layout: ../../../Layout.astro
 ---
 
 # noNegationElse (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noNewSymbol.md b/website/src/pages/lint/rules/noNewSymbol.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noNewSymbol
-layout: ../../../Layout.astro
 ---
 
 # noNewSymbol (since v0.10.0)

diff --git a/website/src/pages/lint/rules/noPositiveTabindex.md b/website/src/pages/lint/rules/noPositiveTabindex.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noPositiveTabindex
-layout: ../../../Layout.astro
 ---
 
 # noPositiveTabindex (since v10.0.0)

diff --git a/website/src/pages/lint/rules/noRenderReturnValue.md b/website/src/pages/lint/rules/noRenderReturnValue.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noRenderReturnValue
-layout: ../../../Layout.astro
 ---
 
 # noRenderReturnValue (since v0.10.0)

diff --git a/website/src/pages/lint/rules/noRestrictedGlobals.md b/website/src/pages/lint/rules/noRestrictedGlobals.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noRestrictedGlobals
-layout: ../../../Layout.astro
 ---
 
 # noRestrictedGlobals (since v0.10.0)

diff --git a/website/src/pages/lint/rules/noShadowRestrictedNames.md b/website/src/pages/lint/rules/noShadowRestrictedNames.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noShadowRestrictedNames
-layout: ../../../Layout.astro
 ---
 
 # noShadowRestrictedNames (since v0.9.0)

diff --git a/website/src/pages/lint/rules/noShoutyConstants.md b/website/src/pages/lint/rules/noShoutyConstants.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noShoutyConstants
-layout: ../../../Layout.astro
 ---
 
 # noShoutyConstants (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noSparseArray.md b/website/src/pages/lint/rules/noSparseArray.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noSparseArray
-layout: ../../../Layout.astro
 ---
 
 # noSparseArray (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noUndeclaredVariables.md b/website/src/pages/lint/rules/noUndeclaredVariables.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noUndeclaredVariables
-layout: ../../../Layout.astro
 ---
 
 # noUndeclaredVariables (since v0.10.0)

diff --git a/website/src/pages/lint/rules/noUnnecessaryContinue.md b/website/src/pages/lint/rules/noUnnecessaryContinue.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noUnnecessaryContinue
-layout: ../../../Layout.astro
 ---
 
 # noUnnecessaryContinue (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noUnreachable.md b/website/src/pages/lint/rules/noUnreachable.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noUnreachable
-layout: ../../../Layout.astro
 ---
 
 # noUnreachable (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noUnsafeNegation.md b/website/src/pages/lint/rules/noUnsafeNegation.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noUnsafeNegation
-layout: ../../../Layout.astro
 ---
 
 # noUnsafeNegation (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noUnusedTemplateLiteral.md b/website/src/pages/lint/rules/noUnusedTemplateLiteral.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noUnusedTemplateLiteral
-layout: ../../../Layout.astro
 ---
 
 # noUnusedTemplateLiteral (since v0.7.0)

diff --git a/website/src/pages/lint/rules/noUnusedVariables.md b/website/src/pages/lint/rules/noUnusedVariables.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noUnusedVariables
-layout: ../../../Layout.astro
 ---
 
 # noUnusedVariables (since v0.9.0)

diff --git a/website/src/pages/lint/rules/noUselessFragments.md b/website/src/pages/lint/rules/noUselessFragments.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noUselessFragments
-layout: ../../../Layout.astro
 ---
 
 # noUselessFragments (since v0.10.0)

diff --git a/website/src/pages/lint/rules/noVoidElementsWithChildren.md b/website/src/pages/lint/rules/noVoidElementsWithChildren.md
@@ -1,6 +1,5 @@
 ---
 title: Lint Rule noVoidElementsWithChildren
-layout: ../../../Layout.astro
 ---
 
 # noVoidElementsWithChildren (since v0.10.0)