diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 1178c45..23af818 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -1,48 +1,47 @@ -import {themes as prismThemes} from 'prism-react-renderer'; -import type {Config} from '@docusaurus/types'; -import type * as Preset from '@docusaurus/preset-classic'; +import { themes as prismThemes } from "prism-react-renderer"; +import type { Config } from "@docusaurus/types"; +import type * as Preset from "@docusaurus/preset-classic"; const config: Config = { - title: 'Smithy Docs', - tagline: 'Focus on the important stuff.', - favicon: 'img/favicon.ico', + title: "Smithy Docs", + tagline: "Focus on the important stuff.", + favicon: "img/favicon.png", // Set the production url of your site here - url: 'https://docs.smithy.security', + url: "https://docs.smithy.security", // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' - baseUrl: '/', + baseUrl: "/", // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. - organizationName: 'ocurity', // Usually your GitHub org/user name. - projectName: 'docs', // Usually your repo name. + organizationName: "ocurity", // Usually your GitHub org/user name. + projectName: "docs", // Usually your repo name. trailingSlash: false, - onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "warn", // Even if you don't use internationalization, you can use this field to set // useful metadata like html lang. For example, if your site is Chinese, you // may want to replace "en" with "zh-Hans". i18n: { - defaultLocale: 'en', - locales: ['en'], + defaultLocale: "en", + locales: ["en"], }, presets: [ [ - 'classic', + "classic", { docs: { - sidebarPath: './sidebars.ts', + sidebarPath: "./sidebars.ts", // Please change this to your repo. // Remove this to remove the "edit this page" links. - editUrl: - 'https://github.com/ocurity/docs/tree/main/', + editUrl: "https://github.com/ocurity/docs/tree/main/", }, theme: { - customCss: './src/css/custom.css', + customCss: "./src/css/custom.css", }, } satisfies Preset.Options, ], @@ -50,62 +49,62 @@ const config: Config = { themeConfig: { // Replace with your project's social card - image: 'img/docusaurus-social-card.jpg', + image: "img/docusaurus-social-card.jpg", navbar: { - title: 'Smithy Docs', + title: "Documentation", logo: { - alt: 'Smithy Logo', - src: 'img/logo.svg', + alt: "Smithy Logo", + src: "img/logo.svg", }, items: [ { - type: 'docSidebar', - sidebarId: 'tutorialSidebar', - position: 'left', - label: 'Tutorial', + type: "docSidebar", + sidebarId: "tutorialSidebar", + position: "left", + label: "Tutorial", }, { - href: 'https://github.com/ocurity/docs', - label: 'GitHub', - position: 'right', + href: "https://github.com/ocurity/docs", + label: "GitHub", + position: "right", }, ], }, footer: { - style: 'dark', + style: "dark", links: [ { - title: 'Docs', + title: "Docs", items: [ { - label: 'Tutorial', - to: '/docs/quickstart', + label: "Tutorial", + to: "/docs/quickstart", }, ], }, { - title: 'Community', + title: "Community", items: [ { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/docusaurus', + label: "Stack Overflow", + href: "https://stackoverflow.com/questions/tagged/docusaurus", }, { - label: 'Discord', - href: 'https://discordapp.com/invite/docusaurus', + label: "Discord", + href: "https://discordapp.com/invite/docusaurus", }, { - label: 'Twitter', - href: 'https://twitter.com/docusaurus', + label: "Twitter", + href: "https://twitter.com/docusaurus", }, ], }, { - title: 'More', + title: "More", items: [ { - label: 'GitHub', - href: 'https://github.com/ocurity/docs', + label: "GitHub", + href: "https://github.com/ocurity/docs", }, ], }, @@ -115,7 +114,7 @@ const config: Config = { prism: { theme: prismThemes.github, darkTheme: prismThemes.dracula, - additionalLanguages: ['bash', 'docker', 'makefile'], + additionalLanguages: ["bash", "docker", "makefile"], }, } satisfies Preset.ThemeConfig, }; diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 9116e5a..c7ac906 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -1,16 +1,16 @@ -import clsx from 'clsx'; -import Link from '@docusaurus/Link'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -import Layout from '@theme/Layout'; -import HomepageFeatures from '@site/src/components/HomepageFeatures'; -import Heading from '@theme/Heading'; +import clsx from "clsx"; +import Link from "@docusaurus/Link"; +import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; +import Layout from "@theme/Layout"; +import HomepageFeatures from "@site/src/components/HomepageFeatures"; +import Heading from "@theme/Heading"; -import styles from './index.module.css'; +import styles from "./index.module.css"; function HomepageHeader() { - const {siteConfig} = useDocusaurusContext(); + const { siteConfig } = useDocusaurusContext(); return ( -
+
{siteConfig.title} @@ -19,7 +19,8 @@ function HomepageHeader() {
+ to="/docs/quickstart" + > Quickstart - 5min ⏱️
@@ -29,11 +30,12 @@ function HomepageHeader() { } export default function Home(): JSX.Element { - const {siteConfig} = useDocusaurusContext(); + const { siteConfig } = useDocusaurusContext(); return ( + title={siteConfig.title} + description="The official documentation for all things Smithy." + >
diff --git a/static/img/docusaurus.png b/static/img/docusaurus.png deleted file mode 100644 index f458149..0000000 Binary files a/static/img/docusaurus.png and /dev/null differ diff --git a/static/img/favicon.ico b/static/img/favicon.ico deleted file mode 100644 index c01d54b..0000000 Binary files a/static/img/favicon.ico and /dev/null differ diff --git a/static/img/favicon.png b/static/img/favicon.png new file mode 100644 index 0000000..ca85b44 Binary files /dev/null and b/static/img/favicon.png differ diff --git a/static/img/logo.svg b/static/img/logo.svg old mode 100644 new mode 100755 index 9db6d0d..5636b61 --- a/static/img/logo.svg +++ b/static/img/logo.svg @@ -1 +1,53 @@ - \ No newline at end of file + + + + + + + + + + + + + + diff --git a/static/img/smithy_icon.png b/static/img/smithy_icon.png new file mode 100755 index 0000000..d3e2338 Binary files /dev/null and b/static/img/smithy_icon.png differ diff --git a/static/img/smithy_icon_mark.png b/static/img/smithy_icon_mark.png new file mode 100755 index 0000000..91fcda2 Binary files /dev/null and b/static/img/smithy_icon_mark.png differ diff --git a/static/img/smithy_mark.png b/static/img/smithy_mark.png new file mode 100755 index 0000000..938bb43 Binary files /dev/null and b/static/img/smithy_mark.png differ diff --git a/static/img/smithy_mark_raw.png b/static/img/smithy_mark_raw.png new file mode 100755 index 0000000..05ac22a Binary files /dev/null and b/static/img/smithy_mark_raw.png differ