Skip to content

Commit

Permalink
Merge pull request #432 from onflow/nialexsan/docusaurus-3
Browse files Browse the repository at this point in the history
update to docusaurus 3
  • Loading branch information
nialexsan authored Nov 6, 2023
2 parents ebfa031 + 4800e15 commit 5ddeb4a
Show file tree
Hide file tree
Showing 10 changed files with 4,178 additions and 3,564 deletions.
2 changes: 1 addition & 1 deletion docs/guides/flow-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Flow CLI
sidebar_label: Install Flow CLI
description: Guide to installing and using Flow CLI
sidebar_position: 2
------
---

## Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/fungible-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: How to Create a Fungible Token on Flow
sidebar_label: Create a Fungible Token
description: Guide to creating a fungible token on Flow with the Flow CLI and Cadence.
sidebar_position: 4
------
---

This article will guide you through the steps to create, deploy, mint, and transfer fungible tokens on Flow.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/nft.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: How to Create an NFT Project on Flow
sidebar_label: Create an NFT Project
description: Guide to creating an NFT Project with the Flow CLI and Cadence.
sidebar_position: 5
------
---

This tutorial dives into the technical steps required to craft an NFT on the Flow blockchain, providing developers with a clear roadmap from setup to deployment.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Staking Collection Guide

This document outlines the steps a token holder can take to stake
using [the `FlowIDTableStaking` contract](../../core-contracts/06-staking-contract-reference.md)
and [the `FlowStakingCollection` contract.](../../core-contracts/11-staking-collection.md/)
and [the `FlowStakingCollection` contract.](../../core-contracts/11-staking-collection.md)
This is the recommended and most supported way to stake FLOW.
It supports any number of nodes and delegators per account, supports locked and unlocked FLOW,
and supports easily interaction with a node's machine account for collector and consensus nodes.
Expand Down
4 changes: 2 additions & 2 deletions docs/tools/flow-cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
title: Flow CLI
sidebar_label: Flow CLI
------
---

## Installation

Expand Down Expand Up @@ -42,7 +42,7 @@ So proceed by starting the emulator:

```
> flow emulator
``
```

After creating your new project you are ready to start writing contracts. The Flow emulator is a simplified local simulation of the Flow network. Running the dev command in the CLI ensures that the contracts are deployed to the Flow emulator for you.

Expand Down
5 changes: 1 addition & 4 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -234,10 +234,7 @@ const config = {
],
],

themes: [
'mdx-v2',
hasTypesense && 'docusaurus-theme-search-typesense',
].filter(Boolean),
themes: [hasTypesense && 'docusaurus-theme-search-typesense'].filter(Boolean),

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
Expand Down
33 changes: 16 additions & 17 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "docusaurus",
"name": "flow-docs",
"version": "0.0.0",
"private": true,
"scripts": {
Expand All @@ -16,44 +16,43 @@
},
"dependencies": {
"@code-hike/mdx": "^0.8.2",
"@docusaurus/core": "^2.4.3",
"@docusaurus/plugin-client-redirects": "^2.4.3",
"@docusaurus/preset-classic": "^2.4.3",
"@docusaurus/types": "^2.4.3",
"@docusaurus/core": "^3.0.0",
"@docusaurus/plugin-client-redirects": "^3.0.0",
"@docusaurus/preset-classic": "^3.0.0",
"@docusaurus/types": "^3.0.0",
"@floating-ui/react-dom": "1.3.0",
"@fortawesome/fontawesome-svg-core": "^6.4.2",
"@fortawesome/free-solid-svg-icons": "^6.4.2",
"@fortawesome/react-fontawesome": "^0.2.0",
"@headlessui/react": "1.7.13",
"@mdx-js/react": "2",
"@tailwindcss/aspect-ratio": "^0.4.2",
"@tailwindcss/forms": "^0.5.6",
"@tailwindcss/line-clamp": "^0.4.4",
"@tailwindcss/typography": "^0.5.10",
"@mdx-js/react": "^3.0.0",
"@tailwindcss/aspect-ratio": "0.4.2",
"@tailwindcss/forms": "0.5.6",
"@tailwindcss/line-clamp": "0.4.4",
"@tailwindcss/typography": "0.5.10",
"autoprefixer": "10.4.14",
"clsx": "^1.2.1",
"date-fns": "2.29.3",
"discord.js": "14.8.0",
"docusaurus-theme-mdx-v2": "^0.1.2",
"docusaurus-theme-search-typesense": "^0.12.0-0",
"docusaurus-theme-search-typesense": "^0.13.1",
"dotenv": "16.0.3",
"eslint-config-prettier": "^8.8.0",
"eslint-plugin-prettier": "^4.2.1",
"postcss": "^8.4.31",
"prettier": "^2.8.7",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"redocusaurus": "1.6.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"redocusaurus": "^1.6.4",
"rehype-katex": "4",
"remark-math": "3",
"tailwind-scrollbar-hide": "1.1.7",
"tailwindcss": "^3.3.5",
"webpack-merge": "5.8.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^2.4.3",
"@tsconfig/docusaurus": "^1.0.5",
"@docusaurus/module-type-aliases": "^3.0.0",
"@tsconfig/docusaurus": "^2.0.2",
"@typescript-eslint/eslint-plugin": "^5.43.0",
"eslint": "^8.0.1",
"eslint-config-standard-with-typescript": "34.0.1",
Expand Down
4 changes: 2 additions & 2 deletions src/theme/DocCard/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import React, { type ReactNode } from 'react';
import clsx from 'clsx';
import Link from '@docusaurus/Link';
import {
findFirstCategoryLink,
findFirstSidebarItemLink,
useDocById,
} from '@docusaurus/theme-common/internal';
import isInternalUrl from '@docusaurus/isInternalUrl';
Expand Down Expand Up @@ -76,7 +76,7 @@ function CardCategory({
}: {
item: PropSidebarItemCategory;
}): JSX.Element | null {
const href = findFirstCategoryLink(item);
const href = findFirstSidebarItemLink(item);

// Unexpected: categories that don't have a link have been filtered upfront
if (!href) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ guards to `require` at every function entry-point, thus validating the `msg.send
[Capabilities](./language/capabilities.md) are defined by linking storage paths (namespaces for contract
storage) to protected objects and then making that linked capability available to other accounts. Public and private
scopes defined for storage paths and Capabilities themselves align precisely with
[PublicAccount](./language/accounts.mdx#publicaccount)/[AuthAccount](./language/accounts.mdx#authaccount) account scopes.
[PublicAccount](./language/accounts.mdx#publicaccount) / [AuthAccount](./language/accounts.mdx#authaccount) account scopes.

Any account can get access to an account's public Capabilities. Public capabilities are created using public paths,
i.e. they have the domain `public`. For example, all accounts have a default public capability linked to the
Expand Down
Loading

1 comment on commit 5ddeb4a

@vercel
Copy link

@vercel vercel bot commented on 5ddeb4a Nov 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.