// @ts-check // Note: type annotations allow type checking and IDEs autocompletion const lightCodeTheme = require("prism-react-renderer/themes/github"); const darkCodeTheme = require("prism-react-renderer/themes/dracula"); /** @type {import('@docusaurus/types').Config} */ const config = { title: "Immich", tagline: "High performance self-hosted photo and video backup solution directly from your mobile phone", url: "https://documentation.immich.app", baseUrl: "/", onBrokenLinks: "throw", onBrokenMarkdownLinks: "warn", favicon: "img/favicon.png", // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. organizationName: "immich-app", // Usually your GitHub org/user name. projectName: "immich", // Usually your repo name. deploymentBranch: "main", // Even if you don't use internalization, 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"], }, plugins: [ async function myPlugin(context, options) { return { name: "docusaurus-tailwindcss", configurePostCss(postcssOptions) { // Appends TailwindCSS and AutoPrefixer. postcssOptions.plugins.push(require("tailwindcss")); postcssOptions.plugins.push(require("autoprefixer")); return postcssOptions; }, }; }, ], presets: [ [ "docusaurus-preset-openapi", /** @type {import('docusaurus-preset-openapi').Options} */ ({ docs: { showLastUpdateAuthor: true, showLastUpdateTime: true, sidebarPath: require.resolve("./sidebars.js"), // Please change this to your repo. // Remove this to remove the "edit this page" links. editUrl: "https://github.com/immich-app/immich/tree/main/docs/", }, api: { path: "../server/immich-openapi-specs.json", routeBasePath: "/docs/api", }, // blog: { // showReadingTime: true, // editUrl: "https://github.com/immich-app/immich/tree/main/docs/", // }, theme: { customCss: require.resolve("./src/css/custom.css"), }, }), ], ], themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ colorMode: { defaultMode: "dark", }, announcementBar: { id: "site_announcement_immich", content: `⚠️ The project is under very active development. Expect bugs and changes. Do not use it as the only way to store your photos and videos!`, backgroundColor: "#593f00", textColor: "#ffefc9", isCloseable: false, }, docs: { sidebar: { autoCollapseCategories: false, }, }, navbar: { logo: { alt: "Immich University Logo", src: "img/color-logo.png", srcDark: "img/logo.png", }, items: [ { to: "/docs/overview/introduction", position: "right", label: "Docs", }, { to: "/docs/api", position: "right", label: "API", }, { href: "https://github.com/immich-app/immich", label: "GitHub", position: "right", }, { href: "https://github.com/orgs/immich-app/projects/1", label: "Roadmap", position: "right", }, ], }, footer: { style: "light", links: [ { title: "Overview", items: [ { label: "Welcome", to: "/docs/overview/introduction", }, { label: "Installation", to: "/docs/install/requirements", }, ], }, { title: "Community", items: [ { label: "Discord", href: "https://discord.com/invite/D8JsnBEuKb", }, ], }, { title: "Links", items: [ // { // label: "Blog", // to: "/blog", // }, { label: "GitHub", href: "https://github.com/immich-app/immich", }, { label: "Roadmap", href: "https://github.com/orgs/immich-app/projects/1", }, ], }, ], copyright: `Immich is available as open source under the terms of the MIT License.`, }, prism: { theme: lightCodeTheme, darkTheme: darkCodeTheme, }, image: "overview/img/feature-panel.png", }), }; module.exports = config;