diff --git a/docusaurus.config.js b/docusaurus.config.js index 5bf6ebe..d2f0e05 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,103 +29,200 @@ const config = { plugins: [ tailwindPlugin, - ["@docusaurus/plugin-content-docs", { id: "Git-101", path: "git_101", routeBasePath: "git_101", sidebarPath: "./sidebars.js" }], - ["@docusaurus/plugin-content-docs", { id: "Python-101", path: "python_101", routeBasePath: "python_101", sidebarPath: "./sidebars.js" }], - ["@docusaurus/plugin-content-docs", { id: "Projects", path: "projects", routeBasePath: "projects", sidebarPath: "./sidebars.js" }], + [ + "@docusaurus/plugin-content-docs", + { + id: "Git-101", + path: "git_101", + routeBasePath: "git_101", + sidebarPath: "./sidebars.js", + }, + ], + [ + "@docusaurus/plugin-content-docs", + { + id: "Python-101", + path: "python_101", + routeBasePath: "python_101", + sidebarPath: "./sidebars.js", + }, + ], + [ + "@docusaurus/plugin-content-docs", + { + id: "Projects", + path: "projects", + routeBasePath: "projects", + sidebarPath: "./sidebars.js", + }, + ], ], themes: ["@docusaurus/theme-mermaid"], markdown: { mermaid: true, hooks: { onBrokenMarkdownLinks: "warn" } }, presets: [ - ["classic", ({ - docs: { - sidebarPath: "./sidebars.js", - routeBasePath: "docs/", - breadcrumbs: true, - showLastUpdateAuthor: true, - include: ["**/*.md", "**/*.mdx"], - exclude: ["**/_*.{js,jsx,ts,tsx,md,mdx}", "**/_*/**", "**/*.test.{js,jsx,ts,tsx}", "**/__tests__/**"], - }, - pages: { - path: "src/pages", - routeBasePath: "", - include: ["**/*.{js,jsx,ts,tsx,md,mdx}"], - exclude: ["**/_*.{js,jsx,ts,tsx,md,mdx}", "**/_*/**", "**/*.test.{js,jsx,ts,tsx}", "**/__tests__/**"], - mdxPageComponent: "@theme/MDXPage", - rehypePlugins: [], - beforeDefaultRemarkPlugins: [], - beforeDefaultRehypePlugins: [], - }, - blog: { - showReadingTime: true, - blogTitle: "The Forge Blog", - blogDescription: "Thoughts on data engineering, software, and the occasional rabbit hole — by Tom Fynes at Fynes Forge.", - blogSidebarTitle: "Recent Posts", - postsPerPage: 10, - feedOptions: { - type: ["rss", "atom"], - xslt: true, - title: "The Forge Blog", - description: "Thoughts on data engineering, software, and the occasional rabbit hole.", - copyright: `Copyright © ${new Date().getFullYear()} Fynes Forge`, + [ + "classic", + { + docs: { + sidebarPath: "./sidebars.js", + routeBasePath: "docs/", + breadcrumbs: true, + showLastUpdateAuthor: true, + include: ["**/*.md", "**/*.mdx"], + exclude: [ + "**/_*.{js,jsx,ts,tsx,md,mdx}", + "**/_*/**", + "**/*.test.{js,jsx,ts,tsx}", + "**/__tests__/**", + ], + }, + pages: { + path: "src/pages", + routeBasePath: "", + include: ["**/*.{js,jsx,ts,tsx,md,mdx}"], + exclude: [ + "**/_*.{js,jsx,ts,tsx,md,mdx}", + "**/_*/**", + "**/*.test.{js,jsx,ts,tsx}", + "**/__tests__/**", + ], + mdxPageComponent: "@theme/MDXPage", + rehypePlugins: [], + beforeDefaultRemarkPlugins: [], + beforeDefaultRehypePlugins: [], }, - onInlineTags: "warn", - onInlineAuthors: "warn", - onUntruncatedBlogPosts: "warn", + blog: { + showReadingTime: true, + blogTitle: "The Forge Blog", + blogDescription: + "Thoughts on data engineering, software, and the occasional rabbit hole — by Tom Fynes at Fynes Forge.", + blogSidebarTitle: "Recent Posts", + postsPerPage: 10, + feedOptions: { + type: ["rss", "atom"], + xslt: true, + title: "The Forge Blog", + description: + "Thoughts on data engineering, software, and the occasional rabbit hole.", + copyright: `Copyright © ${new Date().getFullYear()} Fynes Forge`, + }, + onInlineTags: "warn", + onInlineAuthors: "warn", + onUntruncatedBlogPosts: "warn", + }, + theme: { customCss: "./src/css/custom.css" }, }, - theme: { customCss: "./src/css/custom.css" }, - })], + ], ], - themeConfig: ({ + themeConfig: { image: "img/forge-mark.svg", metadata: [ - { name: "keywords", content: "data engineering, python, sql, software engineering, fynes forge" }, + { + name: "keywords", + content: + "data engineering, python, sql, software engineering, fynes forge", + }, { name: "twitter:card", content: "summary_large_image" }, ], navbar: { title: "", - logo: { alt: "Fynes Forge", src: "img/forge-mark.svg", srcDark: "img/forge-mark.svg" }, + logo: { + alt: "Fynes Forge", + src: "img/forge-mark.svg", + srcDark: "img/forge-mark.svg", + }, items: [ { to: "/blog", label: "The Forge Blog", position: "left" }, - { label: "Courses", position: "left", type: "dropdown", items: [ - { label: "SQL 101", to: "/docs/intro" }, - { label: "Git 101", to: "/git_101/intro" }, - { label: "Python 101", to: "/python_101/intro" }, - ]}, - { label: "Projects", position: "left", type: "dropdown", items: [ - { label: "VS Code Theme", href: "https://github.com/fynes-forge/nebula-nights" }, - { label: "SQL Query Optimiser", to: "/projects/sql-optimiser" }, - { label: "Pipelines", to: "/pipelines" }, - { label: "Dashboard", to: "/dashboard" }, - ]}, - { label: "Resources", position: "left", type: "dropdown", items: [ - { label: "Beginner's Data Toolkit", to: "https://tfynes.gumroad.com/l/phlyc" }, - { label: "Git Cheat Sheet", href: "/downloads/cheatsheet.jpg", target: "_blank", rel: "noopener noreferrer" }, - { label: "SQL Cheat Sheet", href: "/downloads/sql_cheatsheet.jpg", target: "_blank", rel: "noopener noreferrer" }, - ]}, + { + label: "Courses", + position: "left", + type: "dropdown", + items: [ + { label: "SQL 101", to: "/docs/intro" }, + { label: "Git 101", to: "/git_101/intro" }, + { label: "Python 101", to: "/python_101/intro" }, + ], + }, + { + label: "Projects", + position: "left", + type: "dropdown", + items: [ + { + label: "VS Code Theme", + href: "https://github.com/fynes-forge/nebula-nights", + }, + { label: "SQL Query Optimiser", to: "/projects/sql-optimiser" }, + { label: "Pipelines", to: "/pipelines" }, + { label: "Dashboard", to: "/dashboard" }, + ], + }, + { + label: "Resources", + position: "left", + type: "dropdown", + items: [ + { + label: "Beginner's Data Toolkit", + to: "https://tfynes.gumroad.com/l/phlyc", + }, + { + label: "Git Cheat Sheet", + // Use 'href' for static assets and add the leading slash + href: "/downloads/cheatsheet.jpg", + target: "_blank", + }, + { + label: "SQL Cheat Sheet", + href: "/downloads/sql_cheatsheet.jpg", + target: "_blank", + }, + ], + }, { to: "skills", label: "Skills", position: "left" }, { to: "career", label: "Career", position: "left" }, - { href: "https://github.com/fynes-forge", position: "right", className: "navbar-github-link", "aria-label": "Fynes Forge on GitHub" }, + { + href: "https://github.com/fynes-forge", + position: "right", + className: "navbar-github-link", + "aria-label": "Fynes Forge on GitHub", + }, ], }, footer: { style: "dark", links: [ - { title: "Courses", items: [ - { label: "SQL 101", to: "/docs/intro" }, - { label: "Git 101", to: "/git_101/intro" }, - { label: "Python 101", to: "/python_101/intro" }, - ]}, - { title: "Socials", items: [ - { label: "GitHub", href: "https://github.com/fynes-forge" }, - { label: "Stack Overflow", href: "https://www.stackoverflow.com/users/7031452/tom" }, - { label: "LinkedIn", href: "https://www.linkedin.com/in/thomas-f-b00607163/" }, - ]}, - { title: "Contact", items: [ - { label: "tf.dev@icloud.com", to: "mailto:tf.dev@icloud.com" }, - ]}, + { + title: "Courses", + items: [ + { label: "SQL 101", to: "/docs/intro" }, + { label: "Git 101", to: "/git_101/intro" }, + { label: "Python 101", to: "/python_101/intro" }, + ], + }, + { + title: "Socials", + items: [ + { label: "GitHub", href: "https://github.com/fynes-forge" }, + { + label: "Stack Overflow", + href: "https://www.stackoverflow.com/users/7031452/tom", + }, + { + label: "LinkedIn", + href: "https://www.linkedin.com/in/thomas-f-b00607163/", + }, + ], + }, + { + title: "Contact", + items: [ + { label: "tf.dev@icloud.com", to: "mailto:tf.dev@icloud.com" }, + ], + }, ], copyright: `Copyright © ${new Date().getFullYear()} Fynes Forge`, }, @@ -134,7 +231,7 @@ const config = { darkTheme: prismThemes.dracula, additionalLanguages: ["python", "bash", "sql", "typescript"], }, - }), + }, }; export default config;