Skip to content

Commit

Permalink
Merge branch 'master' into cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Dr-Electron committed Jan 13, 2024
2 parents 4e25e3d + cd9dd5c commit 1d849fd
Show file tree
Hide file tree
Showing 15 changed files with 18,191 additions and 2,482 deletions.
2 changes: 1 addition & 1 deletion docs/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ https://api-test.build5.com
Let's do a simple GET Request to get the member's object of `@adam_unchained`:

```ts
```tsx
import { Build5, https } from '@build-5/sdk';
import { Dataset } from '@build-5/interfaces';

Expand Down
15 changes: 9 additions & 6 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
import codeImport from 'remark-code-import';

const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const path = require('path');
const {themes} = require('prism-react-renderer');
const lightTheme = themes.github;
const darkTheme = themes.dracula;

/** @type {import('@docusaurus/types').Config} */
const config = {
Expand Down Expand Up @@ -95,7 +98,7 @@ const config = {
sidebarPath: require.resolve('./sidebars.js'),
remarkPlugins: [
[require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}],
require('remark-code-import'),
[codeImport, {rootDir: path.resolve('../.')}],
],
},
blog: false,
Expand Down Expand Up @@ -178,9 +181,9 @@ const config = {
copyright: `Copyright © ${new Date().getFullYear()} BUILD.5. All Rights Reserved.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
dditionalLanguages: ['ts'],
theme: lightTheme,
darkTheme: darkTheme,
additionalLanguages: ['bash'],
},
}),
};
Expand Down
33 changes: 16 additions & 17 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,27 @@
"typecheck": "tsc"
},
"dependencies": {
"@docusaurus/core": "2.4.1",
"@docusaurus/plugin-content-docs": "^2.4.1",
"@docusaurus/plugin-content-pages": "^2.4.1",
"@docusaurus/preset-classic": "2.4.1",
"@docusaurus/remark-plugin-npm2yarn": "^2.4.1",
"@mdx-js/react": "^1.6.22",
"@docusaurus/core": "3.0.1",
"@docusaurus/plugin-content-docs": "3.0.1",
"@docusaurus/plugin-content-pages": "3.0.1",
"@docusaurus/preset-classic": "3.0.1",
"@docusaurus/remark-plugin-npm2yarn": "3.0.1",
"@mdx-js/react": "3.0.0",
"@saucelabs/theme-github-codeblock": "^0.2.3",
"clsx": "^1.2.1",
"prism-react-renderer": "^1.3.5",
"clsx": "^2.0.0",
"prism-react-renderer": "^2.1.0",
"raw-loader": "^4.0.2",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-router-dom": "5.3.4",
"remark-code-import": "0.4.0"
"react": "^18.2.0",
"react-dom": "^18.2.0",
"remark-code-import": "1.2.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "2.4.1",
"@tsconfig/docusaurus": "^1.0.5",
"docusaurus-plugin-typedoc": "^0.19.2",
"typedoc": "^0.24.8",
"@docusaurus/module-type-aliases": "3.0.1",
"@docusaurus/tsconfig": "3.0.1",
"docusaurus-plugin-typedoc": "^0.22.0",
"typedoc": "^0.25.5",
"typedoc-plugin-markdown": "^3.17.1",
"typescript": "4.9.5"
"typescript": "5.3.3"
},
"browserslist": {
"production": [
Expand Down
5 changes: 2 additions & 3 deletions docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import { Redirect } from '@docusaurus/router';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import HomepageFeatures from '@site/src/components/HomepageFeatures';
import Layout from '@theme/Layout';
import clsx from 'clsx';
import React from 'react';
import { Redirect } from 'react-router-dom';
import styles from './index.module.css';

function HomepageHeader() {
Expand All @@ -21,7 +20,7 @@ export default function Home(): JSX.Element {
const { siteConfig } = useDocusaurusContext();
// Temporary until homepage developed.
return <Redirect to='/docs/overview' />;

return (
<Layout
title={`Welcome to ${siteConfig.title}`}
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 1d849fd

Please sign in to comment.