Commit 5421829

authored

Add documentation (TypeScriptToLua#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 5421829Copy full SHA for 5421829

20 files changed

README.md
docs
docusaurus.config.js
sidebars.json
src
- components/SideBySide
  - index.tsx
  - styles.module.scss
- pages
  - index.tsx
  - play
    - code.ts
- theme/CodeBlock
  - index.js
  - styles.module.scss
static/images
- editor-support-diagnostics.png

`‎README.md‎`

-Original file line number
+Diff line change
 ### Installation
 -```
 +```bash
 $ npm install
 ```
 ### Local Development
 -```
 +```bash
 $ npm run start
 ```

Comments

(0)