Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ module.exports = {
baseUrl: "/",
favicon: "images/favicon.ico",
themeConfig: {
metadata: [
{
name: "keywords",
content: "typescript-to-lua, typescript to lua, tstl, typescript, lua, transpiler, compiler",
},
],
navbar: {
title: "TypeScriptToLua",
logo: { src: "images/logo.png" },
Expand Down
30 changes: 30 additions & 0 deletions src/pages/index.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import Head from "@docusaurus/Head";
import Link from "@docusaurus/Link";
import useBaseUrl from "@docusaurus/useBaseUrl";
import CodeBlock from "@theme/CodeBlock";
Expand Down Expand Up @@ -80,6 +81,16 @@ function Feature({ title, description }: Feature) {
export default function Home() {
return (
<Layout>
<Head>
<meta
property="description"
content="TypeScriptToLua (TSTL) is a transpiler that translates TypeScript code to Lua. This allows working with the great type system and tool support of TypeScript, while keeping compatibility with your Lua environment!"
/>
<meta
property="keywords"
content="typescript-to-lua, typescript to lua, tstl, typescript, lua, transpiler, compiler"
/>
</Head>
<header className={`hero ${styles.heroBanner} container`}>
<h1 className={`hero__title ${styles.title}`}>
<b>Type</b>
Expand Down Expand Up @@ -122,6 +133,25 @@ export default function Home() {
))}
</div>
</section>
<section className="container">
<div className="row">
<div className={`col`}>
<h1>Getting started</h1>
<p>
Getting started with <b>TSTL</b> is easy, simply install typescript-to-lua from npm:
</p>
<CodeBlock>$ npm install -D typescript typescript-to-lua</CodeBlock>
<p>
You can now run <code>tstl</code> via command line, similar to <code>tsc</code>
</p>
<CodeBlock>$ npx tstl</CodeBlock>
<p>
For more information, see{" "}
<a href={useBaseUrl("docs/getting-started")}>tstl Getting Started documentation</a>.
</p>
</div>
</div>
</section>
</main>
</Layout>
);
Expand Down