diff --git a/docs/docs/automation/index.md b/docs/docs/automation-overview.md similarity index 89% rename from docs/docs/automation/index.md rename to docs/docs/automation-overview.md index 332a4e1e..73fe1633 100644 --- a/docs/docs/automation/index.md +++ b/docs/docs/automation-overview.md @@ -1,8 +1,6 @@ --- -id: automation +id: automation-overview title: Set up Maester to automatically run daily -sidebar_label: Daily Automation -sidebar_position: 3 --- This section provides guidance on how to set up Maester to be run as a daily automation. diff --git a/docs/docs-templates/commands-index.md b/docs/docs/commands-overview.md similarity index 87% rename from docs/docs-templates/commands-index.md rename to docs/docs/commands-overview.md index 8d3d22f2..5cd4050c 100644 --- a/docs/docs-templates/commands-index.md +++ b/docs/docs/commands-overview.md @@ -1,7 +1,5 @@ --- -id: commands -title: Command Reference -sidebar_label: Command Reference +id: commands-overview --- ```mdx-code-block diff --git a/docs/docs/tests/index.md b/docs/docs/tests/index.md index db3c3c4d..a45a691a 100644 --- a/docs/docs/tests/index.md +++ b/docs/docs/tests/index.md @@ -1,7 +1,8 @@ --- id: tests title: Maester - Out of the box tests -sidebar_label: Tests Reference +sidebar_label: Overview +sidebar_position: 1 --- ```mdx-code-block diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index ebd57b8f..b7117424 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -47,8 +47,6 @@ const config = { ({ docs: { sidebarPath: "./sidebars.js", - // Please change this to your repo. - // Remove this to remove the "edit this page" links. editUrl: "https://github.com/maester365/docs/tree/main/src/site", }, theme: { @@ -76,6 +74,18 @@ const config = { position: "left", label: "Docs", }, + { + type: "doc", + position: "left", + docId: "tests/tests", + label: "Tests", + }, + { + type: "doc", + position: "left", + docId: "commands-overview", + label: "Commands", + }, { "aria-label": "GitHub Repository", className: "navbar--github-link", diff --git a/docs/sidebars.js b/docs/sidebars.js index 116daf33..1b5ed6b3 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -1,33 +1,38 @@ -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - // @ts-check /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure - siteSidebar: [{ type: "autogenerated", dirName: "." }], - - // But you can create a sidebar manually - /* - tutorialSidebar: [ - 'intro', - 'hello', + siteSidebar: [ + "intro", + "writing-tests", + { + type: "category", + label: "Daily Automation", + collapsed: false, + items: [ + { type: "doc", id: "automation-overview", label: "Overview" }, + { type: "autogenerated", dirName: "automation" }, + ], + }, + "contributing", + { + type: "html", + value: '', + }, + { + type: "category", + label: "Command Reference", + items: [ + { type: "doc", id: "commands-overview", label: "Overview" }, + { type: "autogenerated", dirName: "commands" }, + ], + }, { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], + type: "category", + label: "Test Reference", + items: [{ type: "autogenerated", dirName: "tests" }], }, ], - */ }; export default sidebars; diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 1a641cd9..7bd79fe9 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -81,3 +81,9 @@ html[data-theme="dark"] .navbar--github-link:before { background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat; } + +.sidebar-divider { + border-top: 1px solid var(--ifm-color-gray-200); + display: block; + margin: 0.5rem 0 0.25rem 1rem; +}