Skip to content

Commit

Permalink
build(deps): bump to latest docusaurus
Browse files Browse the repository at this point in the history
  • Loading branch information
sjwall committed Dec 18, 2021
1 parent 51c5cb6 commit 3d6784c
Show file tree
Hide file tree
Showing 4 changed files with 1,517 additions and 2,133 deletions.
24 changes: 16 additions & 8 deletions doc/README.md
Expand Up @@ -4,30 +4,38 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta

## Installation

```console
yarn install
```
$ yarn
```

## Local Development

```console
yarn start
```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
yarn build
```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
126 changes: 64 additions & 62 deletions doc/docusaurus.config.js
Expand Up @@ -16,70 +16,10 @@ const config = {
trailingSlash: true,
organizationName: 'sjwall', // Usually your GitHub org/user name.
projectName: 'mdx-mermaid', // Usually your repo name.
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
title: 'mdx-mermaid',
logo: {
alt: 'mdx-mermaid',
src: 'img/logo.svg',
},
items: [
{
type: 'doc',
docId: 'intro',
position: 'left',
label: 'Tutorial',
},
{
href: 'https://github.com/sjwall/mdx-mermaid',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/intro',
},
],
},
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/mdx-mermaid',
}
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://github.com/sjwall/mdx-mermaid',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Samuel Wall. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),

presets: [
[
'@docusaurus/preset-classic',
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
Expand All @@ -95,6 +35,68 @@ const config = {
}),
],
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
title: 'mdx-mermaid',
logo: {
alt: 'mdx-mermaid',
src: 'img/logo.svg',
},
items: [
{
type: 'doc',
docId: 'intro',
position: 'left',
label: 'Tutorial',
},
{
href: 'https://github.com/sjwall/mdx-mermaid',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/intro',
},
],
},
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/mdx-mermaid',
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://github.com/sjwall/mdx-mermaid',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Samuel Wall. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
};

module.exports = config;
9 changes: 3 additions & 6 deletions doc/package.json
Expand Up @@ -15,18 +15,15 @@
"postinstall": "cd ../node_modules/react && yarn link && cd ../../doc && yarn link react"
},
"dependencies": {
"@docusaurus/core": "2.0.0-beta.8",
"@docusaurus/preset-classic": "2.0.0-beta.8",
"@docusaurus/core": "2.0.0-beta.13",
"@docusaurus/preset-classic": "2.0.0-beta.13",
"@mdx-js/react": "^1.6.21",
"@svgr/webpack": "^5.5.0",
"clsx": "^1.1.1",
"file-loader": "^6.2.0",
"mdx-mermaid": "link:..",
"mermaid": "^8.11.4",
"prism-react-renderer": "^1.2.1",
"react": "^17.0.1",
"react-dom": "^17.0.1",
"url-loader": "^4.1.1"
"react-dom": "^17.0.1"
},
"browserslist": {
"production": [
Expand Down

0 comments on commit 3d6784c

Please sign in to comment.