Skip to content

Commit

Permalink
Updating to Docusaurus v3 (#4078)
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewRTsao authored Feb 21, 2024
1 parent 99a4bc4 commit bbc2e28
Show file tree
Hide file tree
Showing 6 changed files with 6,366 additions and 3,856 deletions.
2 changes: 1 addition & 1 deletion docs/docs/deploy/credentials/athena.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you do not have the AWS CLI installed and authenticated, follow these steps:

3. If your organization does not have SSO configured:

a. Follow the steps described under [How to create an AWS service account using the AWS Management Console](#how-to-create-an-aws-service-account-using-the-aws-management-console), which you will find below on this page.
a. Follow the steps described in [How to create an AWS service account using the AWS Management Console](./s3.md#how-to-create-an-aws-service-account-using-the-aws-management-console).

b. Run the following command and provide the access key, access secret, and default region when prompted (you can leave the "Default output format" blank):
```
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/project-files/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ _**`colors`**_ - used to override the dashboard colors.
- _**`secondary`**_ - overrides the secondary color in the dashboard. Applies to the loading spinner only as of now. Can have any hex (without the # character), [named colors](https://www.w3.org/TR/css-color-4/#named-colors) or hsl() formats.

## Example
You can copy this directly into your <theme_name>.yaml file:
You can copy this directly into your \<theme_name>.yaml file:
```yaml
kind: theme
colors:
Expand Down
6 changes: 4 additions & 2 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
// Note: type annotations allow type checking and IDEs autocompletion

/* eslint @typescript-eslint/no-var-requires: "off" */
const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
const {themes} = require('prism-react-renderer');
const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;

const def = require("redocusaurus");
def;
Expand Down Expand Up @@ -155,6 +156,7 @@ const config = {
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ['bash', 'diff', 'json'],
},
}),

Expand Down
29 changes: 17 additions & 12 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,26 @@
"docusaurus": "docusaurus "
},
"devDependencies": {
"@docusaurus/core": "2.4.3",
"@docusaurus/module-type-aliases": "2.4.3",
"@docusaurus/plugin-client-redirects": "2.4.3",
"@docusaurus/preset-classic": "2.4.3",
"@docusaurus/theme-mermaid": "2.4.3",
"@mdx-js/react": "^1.6.22",
"@tsconfig/docusaurus": "^1.0.5",
"@docusaurus/core": "3.1.1",
"@docusaurus/module-type-aliases": "3.1.1",
"@docusaurus/plugin-client-redirects": "3.1.1",
"@docusaurus/preset-classic": "3.1.1",
"@docusaurus/theme-mermaid": "3.1.1",
"@docusaurus/theme-common": "3.1.1",
"@mdx-js/react": "^3.0.0",
"@docusaurus/tsconfig": "3.1.1",
"@types/react": "^18.2.29",
"clsx": "^1.1.1",
"docusaurus-gtm-plugin": "^0.0.2",
"prism-react-renderer": "^1.3.3",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"redocusaurus": "^1.1.2",
"prism-react-renderer": "^2.1.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"redocusaurus": "^2.0.0",
"tailwindcss": "^3.0.23",
"typescript": "^4.6.4"
"typescript": "^5.2.2"
},
"engines": {
"node": ">=18.0"
},
"browserslist": {
"production": [
Expand Down
2 changes: 1 addition & 1 deletion docs/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
// This file is not used in compilation. It is here just for a nice editor experience.
"extends": "@tsconfig/docusaurus/tsconfig.json",
"extends": "@docusaurus/tsconfig",
"compilerOptions": {
"baseUrl": "."
}
Expand Down
Loading

0 comments on commit bbc2e28

Please sign in to comment.