diff --git a/docs-v2/.prettierrc b/docs-v2/.prettierrc new file mode 100644 index 0000000000000..5393aaf2da6e0 --- /dev/null +++ b/docs-v2/.prettierrc @@ -0,0 +1,5 @@ +{ + "singleQuote": true, + "trailingComma": "all", + "arrowParens": "avoid" +} diff --git a/docs-v2/blog/2019-05-28-first-blog-post.md b/docs-v2/blog/2019-05-28-first-blog-post.md deleted file mode 100644 index 02f3f81bd27b4..0000000000000 --- a/docs-v2/blog/2019-05-28-first-blog-post.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: first-blog-post -title: First Blog Post -authors: - name: Gao Wei - title: Docusaurus Core Team - url: https://github.com/wgao19 - image_url: https://github.com/wgao19.png -tags: [hola, docusaurus] ---- - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/docs-v2/blog/2019-05-29-long-blog-post.md b/docs-v2/blog/2019-05-29-long-blog-post.md deleted file mode 100644 index 26ffb1b1f6534..0000000000000 --- a/docs-v2/blog/2019-05-29-long-blog-post.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: long-blog-post -title: Long Blog Post -authors: endi -tags: [hello, docusaurus] ---- - -This is the summary of a very long blog post, - -Use a `` comment to limit blog post size in the list view. - - - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/docs-v2/blog/2021-08-01-mdx-blog-post.mdx b/docs-v2/blog/2021-08-01-mdx-blog-post.mdx deleted file mode 100644 index c04ebe323ee33..0000000000000 --- a/docs-v2/blog/2021-08-01-mdx-blog-post.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -slug: mdx-blog-post -title: MDX Blog Post -authors: [slorber] -tags: [docusaurus] ---- - -Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/). - -:::tip - -Use the power of React to create interactive blog posts. - -```js - -``` - - - -::: diff --git a/docs-v2/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/docs-v2/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg deleted file mode 100644 index 11bda0928456b..0000000000000 Binary files a/docs-v2/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg and /dev/null differ diff --git a/docs-v2/blog/2021-08-26-welcome/index.md b/docs-v2/blog/2021-08-26-welcome/index.md deleted file mode 100644 index 9455168f17014..0000000000000 --- a/docs-v2/blog/2021-08-26-welcome/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -slug: welcome -title: Welcome -authors: [slorber, yangshun] -tags: [facebook, hello, docusaurus] ---- - -[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog). - -Simply add Markdown files (or folders) to the `blog` directory. - -Regular blog authors can be added to `authors.yml`. - -The blog post date can be extracted from filenames, such as: - -- `2019-05-30-welcome.md` -- `2019-05-30-welcome/index.md` - -A blog post folder can be convenient to co-locate blog post images: - -![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg) - -The blog supports tags as well! - -**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config. diff --git a/docs-v2/blog/authors.yml b/docs-v2/blog/authors.yml deleted file mode 100644 index bcb29915635ca..0000000000000 --- a/docs-v2/blog/authors.yml +++ /dev/null @@ -1,17 +0,0 @@ -endi: - name: Endilie Yacop Sucipto - title: Maintainer of Docusaurus - url: https://github.com/endiliey - image_url: https://github.com/endiliey.png - -yangshun: - name: Yangshun Tay - title: Front End Engineer @ Facebook - url: https://github.com/yangshun - image_url: https://github.com/yangshun.png - -slorber: - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png diff --git a/docs-v2/docs/contribution.md b/docs-v2/docs/contribution.mdx similarity index 100% rename from docs-v2/docs/contribution.md rename to docs-v2/docs/contribution.mdx diff --git a/docs-v2/docs/frequently-asked-questions.md b/docs-v2/docs/frequently-asked-questions.mdx similarity index 100% rename from docs-v2/docs/frequently-asked-questions.md rename to docs-v2/docs/frequently-asked-questions.mdx diff --git a/docs-v2/docs/intro.md b/docs-v2/docs/intro.mdx similarity index 93% rename from docs-v2/docs/intro.md rename to docs-v2/docs/intro.mdx index da0760ea8376f..8f520b4f59507 100644 --- a/docs-v2/docs/intro.md +++ b/docs-v2/docs/intro.mdx @@ -1,9 +1,9 @@ --- -name: Introduction -route: /docs/intro +title: Introduction +hide_title: true sidebar_position: 1 --- -# Introduction + ## What is Apache Superset? Apache Superset is a modern, enterprise-ready business intelligence web application. It @@ -16,10 +16,10 @@ Here are a **few different ways you can get started with Superset**: - Download the [source from Apache Foundation's website](https://dist.apache.org/repos/dist/release/superset/1.0.0/) - Download the latest Superset version from [Pypi here](https://pypi.org/project/apache-superset/) - Setup Superset locally with one command -using [Docker Compose](installation/installing-superset-using-docker-compose) + using [Docker Compose](installation/installing-superset-using-docker-compose) - Download the [Docker image](https://hub.docker.com/r/apache/superset) from Dockerhub - Install the latest version of Superset -[from Github](https://github.com/apache/superset/tree/latest) + [from Github](https://github.com/apache/superset/tree/latest) Superset provides: diff --git a/docs-v2/docs/security.md b/docs-v2/docs/security.mdx similarity index 100% rename from docs-v2/docs/security.md rename to docs-v2/docs/security.mdx diff --git a/docs-v2/docs/tutorial-basics/_category_.json b/docs-v2/docs/tutorial-basics/_category_.json deleted file mode 100644 index 536a9759d3c3a..0000000000000 --- a/docs-v2/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Tutorial - Basics", - "position": 20 -} diff --git a/docs-v2/docs/tutorial-basics/congratulations.md b/docs-v2/docs/tutorial-basics/congratulations.md deleted file mode 100644 index 9ef99bbadd93b..0000000000000 --- a/docs-v2/docs/tutorial-basics/congratulations.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/). -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/docs-v2/docs/tutorial-basics/create-a-blog-post.md b/docs-v2/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index 0d50aaf316313..0000000000000 --- a/docs-v2/docs/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much you like. -``` - -A new blog post is now available at `http://localhost:3000/blog/greetings`. diff --git a/docs-v2/docs/tutorial-basics/create-a-document.md b/docs-v2/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index b4a072ecddc1c..0000000000000 --- a/docs-v2/docs/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at `http://localhost:3000/docs/hello`. - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadatas to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```diff title="sidebars.js" -module.exports = { - tutorialSidebar: [ - { - type: 'category', - label: 'Tutorial', -- items: [...], -+ items: ['hello'], - }, - ], -}; -``` diff --git a/docs-v2/docs/tutorial-basics/create-a-page.md b/docs-v2/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index e112b0059c26b..0000000000000 --- a/docs-v2/docs/tutorial-basics/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` -> `localhost:3000/` -- `src/pages/foo.md` -> `localhost:3000/foo` -- `src/pages/foo/bar.js` -> `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

- - ); -} -``` - -A new page is now available at `http://localhost:3000/my-react-page`. - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at `http://localhost:3000/my-markdown-page`. diff --git a/docs-v2/docs/tutorial-basics/deploy-your-site.md b/docs-v2/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 492eae0276b4a..0000000000000 --- a/docs-v2/docs/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at `http://localhost:3000/`. - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/docs-v2/docs/tutorial-basics/markdown-features.mdx b/docs-v2/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 8855626051f1d..0000000000000 --- a/docs-v2/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,144 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -Add an image at `static/img/docusaurus.png` and display it in Markdown: - -```md -![Docusaurus logo](/img/docusaurus.png) -``` - -![Docusaurus logo](/img/docusaurus.png) - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - - ```jsx title="src/components/HelloDocusaurus.js" - function HelloDocusaurus() { - return ( -

Hello, Docusaurus!

- ) - } - ``` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - - :::tip My tip - - Use this awesome feature option - - ::: - - :::danger Take care - - This action is dangerous - - ::: - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! diff --git a/docs-v2/docs/tutorial-extras/_category_.json b/docs-v2/docs/tutorial-extras/_category_.json deleted file mode 100644 index adba4a02a801a..0000000000000 --- a/docs-v2/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 21 -} diff --git a/docs-v2/docs/tutorial-extras/manage-docs-versions.md b/docs-v2/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index 6335b0ac94b85..0000000000000 --- a/docs-v2/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](/img/tutorial/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/docs-v2/docs/tutorial-extras/translate-your-site.md b/docs-v2/docs/tutorial-extras/translate-your-site.md deleted file mode 100644 index a25c089ed7941..0000000000000 --- a/docs-v2/docs/tutorial-extras/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -module.exports = { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at `http://localhost:3000/fr/` and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a same time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](/img/tutorial/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/docs-v2/docusaurus.config.js b/docs-v2/docusaurus.config.js index 4221b3e3fa2bd..ae9b0984d23ba 100644 --- a/docs-v2/docusaurus.config.js +++ b/docs-v2/docusaurus.config.js @@ -6,15 +6,16 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'My Site', - tagline: 'Dinosaurs are cool', - url: 'https://your-docusaurus-test-site.com', + title: 'Superset', + tagline: + 'Apache Superset is a modern data exploration and visualization platform', + url: 'https://superset.apache.org', baseUrl: '/', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', favicon: 'img/favicon.ico', - organizationName: 'facebook', // Usually your GitHub org/user name. - projectName: 'docusaurus', // Usually your repo name. + organizationName: 'apache', // Usually your GitHub org/user name. + projectName: 'superset', // Usually your repo name. presets: [ [ @@ -43,10 +44,10 @@ const config = { /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ navbar: { - title: 'My Site', logo: { - alt: 'My Site Logo', + alt: 'Superset Logo', src: 'img/superset-logo-horiz.svg', + srcDark: 'img/superset-logo-horiz-dark.svg', }, items: [ { @@ -55,9 +56,11 @@ const config = { position: 'left', label: 'Documentation', }, - {to: '/blog', label: 'Blog', position: 'left'}, + { to: '/gallery', label: 'Gallery', position: 'left' }, + { to: '/community', label: 'Community', position: 'left' }, + { to: '/resources', label: 'Resources', position: 'left' }, { - href: 'https://github.com/facebook/docusaurus', + href: 'https://github.com/apache/superset', label: 'GitHub', position: 'right', }, @@ -95,10 +98,6 @@ const config = { { title: 'More', items: [ - { - label: 'Blog', - to: '/blog', - }, { label: 'GitHub', href: 'https://github.com/facebook/docusaurus', diff --git a/docs-v2/src/css/custom.css b/docs-v2/src/css/custom.css index 818d6eb2f22d4..f1aa5c575d66b 100644 --- a/docs-v2/src/css/custom.css +++ b/docs-v2/src/css/custom.css @@ -14,6 +14,9 @@ --ifm-color-primary-lighter: #a5dbe9; --ifm-color-primary-lightest: #D2EDF4; --ifm-code-font-size: 95%; + --ifm-menu-link-padding-vertical: 12px; + --doc-sidebar-width: 350px !important; + --ifm-navbar-height: none; } .docusaurus-highlight-code-line { @@ -23,10 +26,24 @@ padding: 0 var(--ifm-pre-padding); } -html[data-theme="dark"] .docusaurus-highlight-code-line { +html[data-theme='dark'] .docusaurus-highlight-code-line { background-color: rgba(0, 0, 0, 0.3); } +.navbar__logo { + height: 40px; +} + +.navbar-sidebar__brand { + padding-left: 0; +} + +.menu, +.navbar { + font-size: 14px; + font-weight: 400; +} + /* Hacks to disable Swagger UI's "try it out" interactive mode */ .try-out, .auth-wrapper, @@ -39,3 +56,17 @@ html[data-theme="dark"] .docusaurus-highlight-code-line { .swagger-ui table tr { border: none; } + +.markdown h2:first-child { + margin-top: 0.5em; +} + +@media only screen and (min-width: 800px) { + .navbar__logo { + height: 50px; + } + + .navbar { + padding-left: 0; + } +} diff --git a/docs-v2/src/pages/index.tsx b/docs-v2/src/pages/index.tsx index cc4f721127249..741e3a9e96f3f 100644 --- a/docs-v2/src/pages/index.tsx +++ b/docs-v2/src/pages/index.tsx @@ -7,7 +7,7 @@ import styles from './index.module.css'; import HomepageFeatures from '../components/HomepageFeatures'; function HomepageHeader() { - const {siteConfig} = useDocusaurusContext(); + const { siteConfig } = useDocusaurusContext(); return (
@@ -16,8 +16,9 @@ function HomepageHeader() {
- Docusaurus Tutorial - 5min ⏱️ + to="/docs/intro" + > + Documentation
@@ -26,11 +27,11 @@ function HomepageHeader() { } export default function Home(): JSX.Element { - const {siteConfig} = useDocusaurusContext(); return ( + title="Welcome" + description="Community website for Apache Superset, a data visualization and data exploration platform" + >
diff --git a/docs-v2/static/img/docusaurus.png b/docs-v2/static/img/docusaurus.png deleted file mode 100644 index f458149e3c8f5..0000000000000 Binary files a/docs-v2/static/img/docusaurus.png and /dev/null differ diff --git a/docs-v2/static/img/favicon.ico b/docs-v2/static/img/favicon.ico index c01d54bcd39a5..2bf2c4bde23c0 100644 Binary files a/docs-v2/static/img/favicon.ico and b/docs-v2/static/img/favicon.ico differ diff --git a/docs-v2/static/img/superset-logo-horiz-dark.svg b/docs-v2/static/img/superset-logo-horiz-dark.svg new file mode 100644 index 0000000000000..53d5b2e65b1df --- /dev/null +++ b/docs-v2/static/img/superset-logo-horiz-dark.svg @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs-v2/static/img/tutorial/docsVersionDropdown.png b/docs-v2/static/img/tutorial/docsVersionDropdown.png deleted file mode 100644 index ff1cbe68893d2..0000000000000 Binary files a/docs-v2/static/img/tutorial/docsVersionDropdown.png and /dev/null differ diff --git a/docs-v2/static/img/tutorial/localeDropdown.png b/docs-v2/static/img/tutorial/localeDropdown.png deleted file mode 100644 index d7163f9675249..0000000000000 Binary files a/docs-v2/static/img/tutorial/localeDropdown.png and /dev/null differ