Skip to content

Commit

Permalink
fix: resolve Docusaurus build (gnolang#1351)
Browse files Browse the repository at this point in the history
## Description

This PR fixes dangling HTML tags in the Docusaurus config, as well as
introduces a workflow file that will make sure the Docusaurus
documentation is built correctly

<details><summary>Contributors' checklist...</summary>

- [x] Added new tests, or not needed, or not feasible
- [x] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [x] Updated the official documentation or not needed
- [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [ ] Added references to related issues and PRs
- [ ] Provided any useful hints for running manual tests
- [ ] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>

---------

Co-authored-by: Danny <[email protected]>
  • Loading branch information
2 people authored and moul committed Nov 14, 2023
1 parent f3070ad commit da28506
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 37 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/docusaurus.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: docusaurus build
on:
pull_request:
paths:
- "docs/**"
push:
branches: [ "master" ]

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: '18'

- name: Install Docusaurus Dependencies
run: |
cd misc/docusaurus
yarn install
- name: Build Docusaurus Docs
run: |
cd misc/docusaurus
yarn build
4 changes: 2 additions & 2 deletions docs/explanation/gnovm.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ This enables non-web3 developers to contribute without requiring an understandin

## Getting started

Install [`gno`](./cmd/gno) and refer to the [`examples`](../examples) folder to start developing contracts.
Install [`gno`](../getting-started/local-setup.md) and refer to the [`examples`](https://github.com/gnolang/gno/tree/master/examples) folder to start developing contracts.

Check the [Makefile](./Makefile) to enhance GnoVM, Gnolang, and stdlibs.
Check the [Makefile](https://github.com/gnolang/gno/blob/master/gnovm/Makefile) to enhance GnoVM, Gnolang, and stdlibs.
4 changes: 2 additions & 2 deletions docs/how-to-guides/creating-grc20.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Our _GRC20_ Realm will have the following functionality:

## Prerequisites

We will proceed using the typical directory structure for a Realm found within the [simple-contract guide](simple-contract.md). It is also worthwhile to consult the [GRC20 interface](../../examples/gno.land/p/demo/grc/grc20/igrc20.gno) which we will be importing and utilizing within this guide.
We will proceed using the typical directory structure for a Realm found within the [simple-contract guide](simple-contract.md). It is also worthwhile to consult the [GRC20 interface](https://github.com/gnolang/gno/blob/master/examples/gno.land/p/demo/grc/grc20/igrc20.gno) which we will be importing and utilizing within this guide.

## 1. Importing token package
For this realm, we'll want to import the `grc20` package as this will include the main functionality of our token factory realm.
Expand Down Expand Up @@ -54,7 +54,7 @@ In this code preview, we have:

## 2. Adding token functionality

The following section will be about introducing Public functions to expose functionality imported from the [grc20 package](../../examples/gno.land/p/demo/grc/grc20).
The following section will be about introducing Public functions to expose functionality imported from the [grc20 package](https://github.com/gnolang/gno/tree/master/examples/gno.land/p/demo/grc/grc20).

[embedmd]:# (../assets/how-to-guides/creating-grc20/mytoken-2.gno go)
```go
Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-guides/creating-grc721.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Our _GRC721_ Realm will have the following functionality:

We will proceed using the typical directory structure for a Realm found within
the [simple-contract guide](simple-contract.md). It is also worthwhile to consult
the [GRC721 interface](../../examples/gno.land/p/demo/grc/grc721/igrc721.gno) which we will be borrowing from within
the [GRC721 interface](https://github.com/gnolang/gno/blob/master/examples/gno.land/p/demo/grc/grc721/igrc721.gno) which we will be borrowing from within
this guide.

## 1. Importing token package
Expand Down Expand Up @@ -59,7 +59,7 @@ In this code preview, we have:
## 2. Adding token functionality

The following section will be about introducing Public functions to expose functionality imported from
the [grc721 package](../../examples/gno.land/p/demo/grc/grc721).
the [grc721 package](https://github.com/gnolang/gno/tree/master/examples/gno.land/p/demo/grc/grc721).

[embedmd]:# (../assets/how-to-guides/creating-grc721/mynonfungibletoken-2.gno go)
```go
Expand Down
Loading

0 comments on commit da28506

Please sign in to comment.