From 833d1e35abcbb1c8c2ccb6ec22b4a2336c6032b7 Mon Sep 17 00:00:00 2001 From: Jack Keene Date: Mon, 27 Nov 2023 13:16:37 +0000 Subject: [PATCH] Update configs --- api-docs/docusaurus.config.js | 20 ++++---------------- api-docs/sidebars.js | 14 -------------- api-docs/src/pages/markdown-page.md | 7 ------- api-docs/static/img/logo.svg | 1 - 4 files changed, 4 insertions(+), 38 deletions(-) delete mode 100644 api-docs/src/pages/markdown-page.md delete mode 100644 api-docs/static/img/logo.svg diff --git a/api-docs/docusaurus.config.js b/api-docs/docusaurus.config.js index d58510d27..5c9cab096 100644 --- a/api-docs/docusaurus.config.js +++ b/api-docs/docusaurus.config.js @@ -10,28 +10,16 @@ import { themes as prismThemes } from 'prism-react-renderer'; const config = { title: 'Snowplow Javascript API Docs', favicon: 'img/favicon.ico', - // Set the production url of your site here url: 'http://snowplow.github.io/', - // Set the // pathname under which your site is served - // For GitHub pages deployment, it is often '//' baseUrl: '/snowplow-javascript-tracker/', - - // GitHub pages deployment config. - // If you aren't using GitHub pages, you don't need these. - organizationName: 'snowplow', // Usually your GitHub org/user name. - projectName: 'js-api-docs', // Usually your repo name. - + organizationName: 'snowplow', + projectName: 'snowplow-javascript-tracker', 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'], }, - presets: [ [ 'classic', @@ -55,8 +43,8 @@ const config = { title: 'API Docs', logo: { src: 'img/favicon.ico', - href: '/docs', // Default to `siteConfig.baseUrl`. - target: '_self', // By default, this value is calculated based on the `href` attribute (the external link will open in a new tab, all others in the current one). + href: '/docs', + target: '_self', }, items: [ { diff --git a/api-docs/sidebars.js b/api-docs/sidebars.js index 01d8ab8a8..c1ca6072d 100644 --- a/api-docs/sidebars.js +++ b/api-docs/sidebars.js @@ -2,21 +2,7 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], - - // But you can create a sidebar manually - /* - tutorialSidebar: [ - 'intro', - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], - */ }; export default sidebars; diff --git a/api-docs/src/pages/markdown-page.md b/api-docs/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b66..000000000 --- a/api-docs/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. diff --git a/api-docs/static/img/logo.svg b/api-docs/static/img/logo.svg deleted file mode 100644 index 9db6d0d06..000000000 --- a/api-docs/static/img/logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file