Skip to content

Commit 5421829

Browse files
authored
Add documentation (#6)
* Import documentation from the wiki * Minor style changes * Add custom `CodeBlock` component with file name and playground button * Update relative documentation links * Add `SideBySide` component * Update some code examples * Add `Configuration` page * Add `Editor Support` page * Merge `Differences between Lua and JS` and `Limitations` pages to `Caveats` * Add `API/Plugins` page * Rewrite `Getting Started` page with focus on project install * Remove `Project Design Goals` page * Add `Type-directed emit` section to `Caveats` page * Update API documentation * Create `Advanced` category * Don't use level 1 headings * Add `Declarations` section to `Getting Started` page * Minor improvements * Use admonitions * Improve title annotations on `Writing Declarations` page * More formatting on Writing Declarations page more consistent * Rewrite few sections on Writing Declarations page * Reword local/global install note
1 parent 6360397 commit 5421829

20 files changed

+2359
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern
44

55
### Installation
66

7-
```
7+
```bash
88
$ npm install
99
```
1010

1111
### Local Development
1212

13-
```
13+
```bash
1414
$ npm run start
1515
```
1616

0 commit comments

Comments
 (0)