Skip to content

Commit

Permalink
Merge pull request #233 from zikeji/dev
Browse files Browse the repository at this point in the history
Dependency & documentation updates.
  • Loading branch information
zikeji committed Mar 30, 2021
2 parents 964b06d + f737eda commit 1f71fc4
Show file tree
Hide file tree
Showing 8 changed files with 369 additions and 342 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Expand Up @@ -70,7 +70,7 @@ jobs:
NODE_OPTIONS: --max-old-space-size=4096
run: npm run docs:build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v3.8.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/.vuepress/dist
Expand Down
27 changes: 26 additions & 1 deletion docs/.vuepress/styles/index.styl
Expand Up @@ -96,4 +96,29 @@ body.theme-light
.at-icon-wrapper svg
fill var(--white) !important
.at-label
color var(--white) !important
color var(--white) !important

.meta-item.update-time
float none !important
text-align right
margin-bottom 3px

.copy-code-button
background-color var(--accent-color, #9941d3)

.line-numbers-wrapper
padding 0.5rem 0 !important

.page-nav
padding 0 2.5rem 0
max-width 740px
margin 0 auto
.next
float right
.next, .prev
.icon
position relative
top .125em
width 1em
height 1em
color var(--accent-color)
1 change: 0 additions & 1 deletion docs/api/README.md
@@ -1,7 +1,6 @@
---
layout: Custom
sidebar: false
footer: true
---
<ClientOnly>
<OpenAPI/>
Expand Down
6 changes: 1 addition & 5 deletions docs/guide/helpers/minecraft-item-data.md
Expand Up @@ -30,10 +30,6 @@ npm install --save prismarine-nbt@1.5.0

When used with Deno, this library imports the [nbt_paser](https://deno.land/x/nbt_parser) library. You do not need to install it separately.

#### Important Note

Due to a possible bug ((#1)[https://github.com/mcbobby123/nbt_parser/issues/1]) in the parsing library, it appears some inventories are not parsed and thus will be missed. I recommend using this helper in Deno with caution.

## Type Hinting (IntelliSense)

The primary function of this helper aside from converting the raw NBT data, is to add type definitions to the data itself - allowing you to easily use the data. The helper goes as far as resolving backpack and bag data into inventory data as well. This means you get intellisense to help you explore the data and find what you need.
Expand Down Expand Up @@ -146,4 +142,4 @@ const client = new Hypixel("API_KEY");
// output:
[ 309, 300, 307, 298 ]
})();
```
```

0 comments on commit 1f71fc4

Please sign in to comment.