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

Structure Updates #947

Merged
merged 10 commits into from
Jul 30, 2024
Merged
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
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# MultiversX docs
# MultiversX Docs

The repository contains the [documentation](https://docs.multiversx.com) for the MultiversX Network protocol.

![docs.multiversx.com](https://github.com/multiversx/mx-docs/blob/main/static/img/share.jpg)

## About

The documentation is built over a custom [docusaurus](https://docusaurus.io/) solution and relies on Markdown files.
Expand All @@ -11,13 +13,13 @@ This repository also has GitHub actions that will trigger the real-time updating

In order to ensure that the newly added content is correctly aligned and every Markdown feature is working as intended, one can run the project on a local machine.

### Requirements:
### Requirements

- a `git` client installed
- `nodejs` (v16.14.2) and `npm` installed
- `nodejs` (v18.19.0 LTS) and `npm` installed
- optional, but useful: an IDE (Visual Code for example)

### Steps:
### Steps

- clone the repository
- run `npm install` (only for the first usage)
Expand All @@ -44,7 +46,7 @@ Anyone can contribute to the docs. Any help is appreciated. Here are some ways i

### Guidelines

Each documentation page should include a `Edit this page` link that will redirect the user to the corresponding GitHub edit page.
Each documentation page should include a `Edit this page` link that will redirect the user to the corresponding GitHub edit page.

Alternatively, contributions can be made manually by following the steps below:

Expand Down
85 changes: 83 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,17 @@ const config = {

// Replace with your project's social card
image: "img/share.jpg",

metadata: [
{ name: "twitter:site", content: "@MultiversX" },
{ name: "twitter:creator", content: "@MultiversX" },
{ name: "twitter:title", content: "MultiversX Docs" },
{
name: "twitter:description",
content:
"A highly scalable, fast and secure blockchain platform for distributed apps, enterprise use cases and the new internet economy.",
},
],
navbar: {
logo: {
alt: "MultiversX Docs",
Expand Down Expand Up @@ -193,7 +204,16 @@ const config = {
prism: {
theme: prismThemes.vsLight,
darkTheme: prismThemes.vsDark,
additionalLanguages: ["rust", "tsx", "toml", "bash", "diff", "json", "solidity", "yaml"],
additionalLanguages: [
"rust",
"tsx",
"toml",
"bash",
"diff",
"json",
"solidity",
"yaml",
],
},
algolia: {
// The application ID provided by Algolia
Expand Down Expand Up @@ -492,7 +512,68 @@ const config = {
},
},
],
async function myPlugin(context, options) {
[
"pwa",
{
// debug: isDeployPreview,
offlineModeActivationStrategies: [
"appInstalled",
"standalone",
"queryString",
],
// swRegister: false,
// swCustom: require.resolve("./src/sw.js"), // TODO make it possible to use relative path
pwaHead: [
{
tagName: "link",
rel: "icon",
href: "img/favicons/apple-touch-icon.png",
},
{
tagName: "link",
rel: "manifest",
href: "manifest/manifest.json",
},
{
tagName: "meta",
name: "theme-color",
content: "rgb(14, 14, 14)",
},
{
tagName: "meta",
name: "apple-mobile-web-app-capable",
content: "yes",
},
{
tagName: "meta",
name: "apple-mobile-web-app-status-bar-style",
content: "#0e0e0e",
},
{
tagName: "link",
rel: "apple-touch-icon",
href: "img/favicons/apple-touch-icon.png",
},
{
tagName: "link",
rel: "mask-icon",
href: "img/favicons/apple-touch-icon.png",
color: "rgb(14, 14, 14)",
},
{
tagName: "meta",
name: "msapplication-TileImage",
content: "img/favicons/mstile-150x150.png",
},
{
tagName: "meta",
name: "msapplication-TileColor",
content: "#0e0e0e",
},
],
},
],
async function tailwindPlugin(context, options) {
return {
name: "docusaurus-tailwindcss",
configurePostCss(postcssOptions) {
Expand Down
Loading
Loading