Skip to content

Commit

Permalink
Improve code blocks
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanLua committed May 16, 2024
1 parent 487ea81 commit 8aaafbc
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,13 @@ More attributes can be found in the [API Reference](api-reference.md). The list

Satchel offers methods and events for scripting purposes. In the below code example we will use the `SetBackpackEnabled` method to disable the Satchel. The script expects the Satchel module to be in [`ReplicatedStorage`](https://create.roblox.com/docs/reference/engine/classes/ReplicatedStorage).

```lua
``` lua title="LocalScript" linenums="1"

Check failure on line 38 in docs/usage.md

View workflow job for this annotation

GitHub Actions / lint

Code block style

docs/usage.md:38 MD046/code-block-style Code block style [Expected: indented; Actual: fenced] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md046.md

Check failure on line 38 in docs/usage.md

View workflow job for this annotation

GitHub Actions / lint

Code block style

docs/usage.md:38 MD046/code-block-style Code block style [Expected: indented; Actual: fenced] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md046.md
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Satchel = require(ReplicatedStorage:WaitForChild("Satchel"))

-- Disable Satchel
Satchel.SetBackpackEnabled(false)
Satchel.SetBackpackEnabled(false) -- (1)!
```

For the full API reference, see [API Reference](api-reference.md) for more details on attributes, methods, and events for Satchel and how to use Satchel to it's full potential.
1. Disable Satchel using the [SetBackpackEnabled](api-reference.md#setbackpackenabled) method.

For the full API reference, see [API Reference](api-reference.md) for more details on attributes, methods, and events for Satchel and how to use Satchel to it's full potential.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ theme:
- content.action.edit
- content.code.copy
- content.tooltips
- content.code.annotate
# - navigation.instant
# - navigation.instant.progress
- navigation.top
Expand Down

0 comments on commit 8aaafbc

Please sign in to comment.