Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to docusaurus v3 #271

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .yarnrc.yml

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

Expand Down
12 changes: 0 additions & 12 deletions blog/2019-05-28-first-blog-post.md

This file was deleted.

44 changes: 0 additions & 44 deletions blog/2019-05-29-long-blog-post.md

This file was deleted.

20 changes: 0 additions & 20 deletions blog/2021-08-01-mdx-blog-post.mdx

This file was deleted.

Binary file not shown.
25 changes: 0 additions & 25 deletions blog/2021-08-26-welcome/index.md

This file was deleted.

17 changes: 0 additions & 17 deletions blog/authors.yml

This file was deleted.

6 changes: 3 additions & 3 deletions docs/build/api/grpc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ The [gRPC](https://grpc.io/) API allows you to communicate with the Massa blockc
The Massa gRPC API is splitted in two parts:

- **Public API**: used for blockchain interactions. Default port:
33037 e.g. <grpc://localhost:33037>
33037 e.g. [](grpc://localhost:33037)
- **Private API**: used for node management. Default port: 33038 e.g.
<grpc://localhost:33038>
[](grpc://localhost:33038)

:::info
To enable events (blocks, endorsements, operations...) brodcast via gRPC streams in your Massa node, add or edit the file
Expand Down Expand Up @@ -70,7 +70,7 @@ directories:
```

By specifying the directories in the configuration file, Buf knows which
[.proto]{.title-ref} files to include in the build process.
`[.proto]{.title-ref}` files to include in the build process.

1. Create a file called `buf.gen.yml` and add the following content:

Expand Down
8 changes: 4 additions & 4 deletions docs/build/api/jsonrpc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ The JsonRPC API allows you to communicate with the Massa blockchain.
The Massa JSON-RPC API is splitted in two parts:

- **Private API**: used for node management. Default port: 33034 e.g.
<http://localhost:33034>
[](http://localhost:33034)
- **Public API**: used for blockchain interactions. Default port:
33035 e.g. <http://localhost:33035>
33035 e.g. [](http://localhost:33035)

The complete Massa [OpenRPC](https://spec.open-rpc.org/) specification is available
[here](https://raw.githubusercontent.com/massalabs/massa/main/massa-node/base_config/openrpc.json).
Expand All @@ -28,9 +28,9 @@ Massa has a new experimental API with both Http and WebSocket support:
Default port: 33036

- **Http**: used for node management and blockchain interactions. e.g.
<http://localhost:33036>
[](http://localhost:33036)
- **WebSocket**: used for streaming blockchain events. e.g.
<ws://localhost:33036>
[](ws://localhost:33036)
:::

## Integrations
Expand Down
16 changes: 9 additions & 7 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
// `@type` JSDoc annotations allow editor autocompletion and type checking
// (when paired with `@ts-check`).
// There are various equivalent ways to declare your Docusaurus config.
// See: https://docusaurus.io/docs/api/docusaurus-config

const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
import {themes as prismThemes} from 'prism-react-renderer';
const math = require("remark-math");
const katex = require("rehype-katex");
const remarkGridTables = require('remark-grid-tables');
Expand Down Expand Up @@ -55,7 +57,7 @@ const config = {
sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/massalabs/docu-dev/tree/main/",
editUrl: "https://github.com/massalabs/docs/tree/main/",
showLastUpdateAuthor: true,
showLastUpdateTime: true,
remarkPlugins: [math, remarkGridTables],
Expand Down Expand Up @@ -171,12 +173,12 @@ const config = {
placeholder: "Search the Docs...",
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
// See https://docusaurus.io/docs/markdown-features/code-blocks#supported-languages
additionalLanguages: ['toml', 'json', 'bash', 'powershell', 'protobuf'],
},
},
};

module.exports = config;
export default config;
Loading
Loading