Skip to content

Commit 89020ca

Browse files
committed
docs: try fix index in readme
1 parent 4a95249 commit 89020ca

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ Embed real Lua (5.1-5.4) and LuaJIT in Node.js with native N-API bindings. Creat
1212
<a href="#installation">Installation</a> •
1313
<a href="#basic-usage">Usage</a> •
1414
<a href="#api-reference">API</a> •
15-
<a href="#type-mapping">Type Mapping</a> •
15+
<a href="#type-mapping">Mapping</a> •
1616
<a href="#cli">CLI</a> •
1717
<a href="#performance">Performance</a>
1818
</p>
1919

20-
## ⚙️ [Features](#features)
20+
## ⚙️ Features <a id="features"></a>
2121

2222
-**Multiple Lua versions** - Supports Lua 5.1–5.4 and LuaJIT
2323
- 🧰 **Prebuilt Binaries** - Lua 5.4.8 included for Linux/macOS/Windows
@@ -26,7 +26,7 @@ Embed real Lua (5.1-5.4) and LuaJIT in Node.js with native N-API bindings. Creat
2626
- 🎯 **TypeScript-ready** - Full type definitions included
2727
- 🚀 **Native performance** - N-API bindings, no WebAssembly overhead
2828

29-
## [Quick Start](#quick-start)
29+
## ⚡ Quick Start <a id="quick-start"></a>
3030

3131
```bash
3232
npm install lua-state
@@ -42,7 +42,7 @@ const result = lua.eval('return "Hello, " .. name');
4242
console.log(result); // → "Hello, World"
4343
```
4444

45-
## 📦 [Installation](#installation)
45+
## 📦 Installation <a id="installation"></a>
4646

4747
Prebuilt binaries are currently available for Lua 5.4.8 and downloaded automatically from [GitHub Releases](https://github.com/quaternion/node-lua-state/releases).
4848
If a prebuilt binary is available for your platform, installation is instant - no compilation required. Otherwise, it will automatically build from source.
@@ -51,7 +51,7 @@ If a prebuilt binary is available for your platform, installation is instant - n
5151
5252
> **Tip:** if you only use prebuilt binaries you can reduce install size with `npm install lua-state --no-optional`.
5353
54-
## 🧠 [Basic Usage](#basic-usage)
54+
## 🧠 Basic Usage <a id="basic-usage"></a>
5555

5656
```js
5757
const lua = new LuaState();
@@ -129,7 +129,7 @@ All Lua operations in `lua-state` are **synchronous** by design. The Lua VM runs
129129

130130
> ⚠️ **Note**: Lua 5.1 and LuaJIT have a small internal C stack, which may cause stack overflows when calling JS functions in very deep loops. Lua 5.1.1+ uses a larger stack and does not have this limitation.
131131
132-
## 🧩 [API Reference](#api-reference)
132+
## 🧩 API Reference <a id="api-reference"></a>
133133

134134
### `LuaState` Class
135135

@@ -152,7 +152,7 @@ new LuaState(options?: {
152152
| `getLength(path)` | Get length of table | `number \| null \| undefined` |
153153
| `getVersion()` | Get Lua version | `string` |
154154

155-
## 🔄 [Type Mapping (JS ⇄ Lua)](#type-mapping)
155+
## 🔄 Type Mapping (JS ⇄ Lua) <a id="type-mapping"></a>
156156

157157
When values are passed between JavaScript and Lua, they’re automatically converted according to the tables below. Circular references are supported internally and won’t cause infinite recursion.
158158

@@ -200,7 +200,7 @@ const anyValue = lua.eval("return { x = 1 }"); // LuaValue | undefined
200200
const numberValue = lua.eval<number>("return 42"); // number
201201
```
202202

203-
## 🧰 [CLI](#cli)
203+
## 🧰 CLI <a id="cli"></a>
204204

205205
<details>
206206
<summary><strong><code>install</code></strong></summary>
@@ -303,7 +303,7 @@ These variables can be used for CI/CD or custom build scripts.
303303
| lua-native | 5.4 (N-API) || Native N-API | Active project, no multi-version support |
304304
| **lua-state** | **5.1–5.4, LuaJIT** || Native N-API | Multi-version, prebuilt binaries, modern API |
305305

306-
## [Performance](#performance)
306+
## ⚡ Performance <a id="performance"></a>
307307

308308
Benchmarked on Lua 5.4.8 (Ryzen 7900X, Debian Bookworm, Node.js 24):
309309

0 commit comments

Comments
 (0)