-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
33 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
<hr /><p style='text-align: center;'>Last update: Sat Jul 24 21:14:14 CEST 2021</p> | ||
<hr /><p style='text-align: center;'>Last update: Thu Nov 2 01:33:56 CET 2023</p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,10 +8,17 @@ | |
<style> | ||
code{white-space: pre-wrap;} | ||
span.smallcaps{font-variant: small-caps;} | ||
span.underline{text-decoration: underline;} | ||
div.column{display: inline-block; vertical-align: top; width: 50%;} | ||
div.columns{display: flex; gap: min(4vw, 1.5em);} | ||
div.column{flex: auto; overflow-x: auto;} | ||
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} | ||
ul.task-list{list-style: none;} | ||
ul.task-list li input[type="checkbox"] { | ||
width: 0.8em; | ||
margin: 0 0.8em 0.2em -1.6em; | ||
vertical-align: middle; | ||
} | ||
.display.math{display: block; text-align: center; margin: 0.5rem auto;} | ||
/* CSS for syntax highlighting */ | ||
pre > code.sourceCode { white-space: pre; position: relative; } | ||
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; } | ||
pre > code.sourceCode > span:empty { height: 1.2em; } | ||
|
@@ -50,7 +57,7 @@ | |
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */ | ||
code span.at { color: #7d9029; } /* Attribute */ | ||
code span.bn { color: #40a070; } /* BaseN */ | ||
code span.bu { } /* BuiltIn */ | ||
code span.bu { color: #008000; } /* BuiltIn */ | ||
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */ | ||
code span.ch { color: #4070a0; } /* Char */ | ||
code span.cn { color: #880000; } /* Constant */ | ||
|
@@ -63,7 +70,7 @@ | |
code span.ex { } /* Extension */ | ||
code span.fl { color: #40a070; } /* Float */ | ||
code span.fu { color: #06287e; } /* Function */ | ||
code span.im { } /* Import */ | ||
code span.im { color: #008000; font-weight: bold; } /* Import */ | ||
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */ | ||
code span.kw { color: #007020; font-weight: bold; } /* Keyword */ | ||
code span.op { color: #666666; } /* Operator */ | ||
|
@@ -75,7 +82,6 @@ | |
code span.va { color: #19177c; } /* Variable */ | ||
code span.vs { color: #4070a0; } /* VerbatimString */ | ||
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */ | ||
.display.math{display: block; text-align: center; margin: 0.5rem auto;} | ||
</style> | ||
<link rel="stylesheet" href="styles.css" /> | ||
<!--[if lt IE 9]> | ||
|
@@ -89,28 +95,38 @@ <h1 id="quickjs-types">QuickJS Types</h1> | |
<p>TypeScript definitions for the QuickJS Engine!</p> | ||
</blockquote> | ||
<p> <!-- Create some extra space --></p> | ||
<p><a href="https://github.com/mgred/quickjs-types/actions/workflows/build_page.yaml"><img src="https://github.com/mgred/quickjs-types/actions/workflows/build_page.yaml/badge.svg?branch=main" alt="Build & Publish Page" /></a> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img src="https://img.shields.io/badge/License-GPL%20v3-yellow.svg" alt="GPLv3 License" /></a></p> | ||
<p><a | ||
href="https://github.com/mgred/quickjs-types/actions/workflows/build_page.yaml"><img | ||
src="https://github.com/mgred/quickjs-types/actions/workflows/build_page.yaml/badge.svg?branch=main" | ||
alt="Build & Publish Page" /></a> <a | ||
href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img | ||
src="https://img.shields.io/badge/License-GPL%20v3-yellow.svg" | ||
alt="GPLv3 License" /></a></p> | ||
<h2 id="usage">Usage</h2> | ||
<p>Add a submodule to a project, e.g. <code>types/quickjs</code>:</p> | ||
<div class="sourceCode" id="cb1"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> submodule add [email protected]:mgred/quickjs-types.git types/quickjs</span></code></pre></div> | ||
<div class="sourceCode" id="cb1"><pre | ||
class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> submodule add [email protected]:mgred/quickjs-types.git types/quickjs</span></code></pre></div> | ||
<p>Extend <code>tsconfig.json</code> to use types:</p> | ||
<div class="sourceCode" id="cb2"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span> | ||
<div class="sourceCode" id="cb2"><pre | ||
class="sourceCode json"><code class="sourceCode json"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span> | ||
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">"compilerOptions"</span><span class="fu">:</span> <span class="fu">{</span></span> | ||
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">"typeRoots"</span><span class="fu">:</span> <span class="ot">[</span><span class="st">"types"</span><span class="ot">]</span></span> | ||
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span> | ||
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div> | ||
<h2 id="tests">Tests</h2> | ||
<p>All tests live in <code>test.ts</code>. To verify everyting passes, run:</p> | ||
<div class="sourceCode" id="cb3"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="ex">tsc</span> <span class="at">-p</span> .</span></code></pre></div> | ||
<p>All tests live in <code>test.ts</code>. To verify everyting passes, | ||
run:</p> | ||
<div class="sourceCode" id="cb3"><pre | ||
class="sourceCode bash"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="ex">tsc</span> <span class="at">-p</span> .</span></code></pre></div> | ||
<h2 id="license">License</h2> | ||
<p>Code in this repository is licensed under the <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GNU General Public License v3</a></p> | ||
<p>Code in this repository is licensed under the <a | ||
href="https://www.gnu.org/licenses/gpl-3.0.en.html">GNU General Public | ||
License v3</a></p> | ||
<h2 id="todos">Todos</h2> | ||
<ul class="task-list"> | ||
<li><input type="checkbox" disabled="" /> | ||
Add more tests</li> | ||
<li><input type="checkbox" disabled="" /> | ||
Add more documentation (comments)</li> | ||
<li><input type="checkbox" />Add more tests</li> | ||
<li><input type="checkbox" />Add more documentation (comments)</li> | ||
</ul> | ||
<hr /><p style='text-align: center;'>Last update: Sat Jul 24 21:14:14 CEST 2021</p> | ||
<hr /><p style='text-align: center;'>Last update: Thu Nov 2 01:33:56 CET 2023</p> | ||
</body> | ||
</html> |