Add new documentation

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/.nvmrc

@@ -0,0 +1 @@
+18

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/docs/building.md

@@ -0,0 +1,12 @@
+---
+sidebar_position: 2
+---
+
+# Building
+
+QuickJS uses [CMake] as its main build system, with an additional helper [Makefile].
+
+WIP.
+
+[CMake]: https://cmake.org
+[Makefile]: https://www.gnu.org/software/make/

docs/docs/cli.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 4
+---
+
+# The qjs and qjsc CLI tools
+
+WIP.

docs/docs/developer-guide/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Developer Guide",
+  "position": 5,
+  "link": {
+    "type": "generated-index"
+  }
+}

docs/docs/developer-guide/custom_modules.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 5
+---
+
+# Custom modules
+
+WIP.

docs/docs/developer-guide/eval.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 3
+---
+
+# Evaluating code
+
+WIP.

docs/docs/developer-guide/intro.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+WIP.

docs/docs/developer-guide/runtime_context.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 2
+---
+
+# JSRuntime and JSContext
+
+WIP.

docs/docs/developer-guide/values.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 4
+---
+
+# Working with values
+
+WIP.

docs/docs/es_features.md

@@ -0,0 +1,3 @@
+# ECMAScript Features
+
+WIP.

docs/docs/installation.md

@@ -0,0 +1,34 @@
+---
+sidebar_position: 3
+---
+
+# Installation
+
+Installing QuickJS is simple, and we provide several ways to do so.
+
+
+## Build from source
+
+If you built it from source as outlined in [building](./building) you can just run:
+
+```bash
+make install
+```
+
+and it will be installed in your system. The default installation path is `/usr/local`.
+
+
+## Using a prebuilt binary
+
+Each [release on GitHub] includes binaries for several systems.
+
+
+## Using jsvu
+
+As of version 2.2.0 of `jsvu`, QuickJS-ng will be installed when the `quickjs` engine is requested.
+
+```bash
+npm install jsvu -g
+```
+
+[release on GitHub]: https://github.com/quickjs-ng/quickjs/releases

docs/docs/intro.md

@@ -0,0 +1,25 @@
+---
+slug: /
+sidebar_position: 1
+sidebar_label: Welcome
+---
+
+# Welcome to QuickJS
+
+QuickJS is a small and embeddable Javascript engine. It supports the [ES2023] specification
+including modules, asynchronous generators, proxies, BigInt and more.
+
+This project is a _fork_ of the [original QuickJS project] by Fabrice Bellard, after it went
+dormant for several years.
+
+:::note
+
+This site is under construction, the entire API is not yet documented.
+:::
+
+## Getting Started
+
+WIP.
+
+[ES2023]: https://tc39.es/ecma262/
+[original QuickJS project]: https://bellard.org/quickjs

docs/docs/supported_platforms.md

@@ -0,0 +1,3 @@
+# Supported Platforms
+
+WIP.

docs/docusaurus.config.js

@@ -0,0 +1,122 @@
+// @ts-check
+// `@type` JSDoc annotations allow editor autocompletion and type checking
+// (when paired with `@ts-check`).
+// There are various equivalent ways to declare your Docusaurus config.
+// See: https://docusaurus.io/docs/api/docusaurus-config
+
+import {themes as prismThemes} from 'prism-react-renderer';
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'QuickJS-NG',
+  tagline: 'QuickJS, the Next Generation: a mighty JavaScript engine',
+  favicon: 'img/favicon.ico',
+
+  // Set the production url of your site here
+  url: 'https://quickjs-ng.github.io',
+  // Set the /<baseUrl>/ pathname under which your site is served
+  // For GitHub pages deployment, it is often '/<projectName>/'
+  baseUrl: '/quickjs/',
+
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
+  organizationName: 'quickjs-ng', // Usually your GitHub org/user name.
+  projectName: 'quickjs', // Usually your repo name.
+
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+
+  // Even if you don't use internationalization, you can use this field to set
+  // useful metadata like html lang. For example, if your site is Chinese, you
+  // may want to replace "en" with "zh-Hans".
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          routeBasePath: '/',
+          sidebarPath: './sidebars.js',
+          // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
+          editUrl: 'https://github.com/quickjs-ng/quickjs/tree/master/docs/',
+        },
+        blog: false,
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      }),
+    ],
+  ],
+
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      // Replace with your project's social card
+      image: 'img/docusaurus-social-card.jpg',
+      navbar: {
+        title: 'QuickJS',
+        items: [
+          {
+            type: 'docSidebar',
+            sidebarId: 'docsSidebar',
+            position: 'left',
+            label: 'Documentation',
+          },
+          {
+            href: 'https://github.com/quickjs-ng/quickjs',
+            label: 'GitHub',
+            position: 'right',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Docs',
+            items: [
+              {
+                label: 'Tutorial',
+                to: '/docs/intro',
+              },
+            ],
+          },
+          {
+            title: 'Community',
+            items: [
+              {
+                label: 'GitHub Discussions',
+                href: 'https://github.com/quickjs-ng/quickjs/discussions',
+              },
+              {
+                label: 'Matrix',
+                href: 'https://matrix.to/#/%23quickjs-ng%3Amatrix.org?via=matrix.org',
+              },
+            ],
+          },
+          {
+            title: 'More',
+            items: [
+              {
+                label: 'GitHub',
+                href: 'https://github.com/quickjs-ng/quickjs',
+              },
+            ],
+          },
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} QuickJS-NG project contributors.`,
+      },
+      prism: {
+        theme: prismThemes.github,
+        darkTheme: prismThemes.dracula,
+      },
+    }),
+};
+
+export default config;

docs/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "docs-ng",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "docusaurus": "docusaurus",
+    "start": "docusaurus start",
+    "build": "docusaurus build",
+    "swizzle": "docusaurus swizzle",
+    "deploy": "docusaurus deploy",
+    "clear": "docusaurus clear",
+    "serve": "docusaurus serve",
+    "write-translations": "docusaurus write-translations",
+    "write-heading-ids": "docusaurus write-heading-ids"
+  },
+  "dependencies": {
+    "@docusaurus/core": "^3.1.1",
+    "@docusaurus/preset-classic": "^3.1.1",
+    "@mdx-js/react": "^3.0.0",
+    "clsx": "^1.2.1",
+    "prism-react-renderer": "^2.1.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "^3.1.1",
+    "@docusaurus/types": "^3.1.1"
+  },
+  "browserslist": {
+    "production": [
+      ">0.5%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 3 chrome version",
+      "last 3 firefox version",
+      "last 5 safari version"
+    ]
+  },
+  "engines": {
+    "node": ">=18.0"
+  }
+}

docs/sidebars.js

@@ -0,0 +1,20 @@
+/**
+ * Creating a sidebar enables you to:
+ - create an ordered group of docs
+ - render a sidebar for each doc of that group
+ - provide next/previous navigation
+
+ The sidebars can be generated from the filesystem, or explicitly defined here.
+
+ Create as many sidebars as you want.
+ */
+
+// @ts-check
+
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const sidebars = {
+  // By default, Docusaurus generates a sidebar from the docs folder structure
+  docsSidebar: [{type: 'autogenerated', dirName: '.'}],
+};
+
+export default sidebars;

docs/src/css/custom.css

@@ -0,0 +1,30 @@
+/**
+ * Any CSS included here will be global. The classic template
+ * bundles Infima by default. Infima is a CSS framework designed to
+ * work well for content-centric websites.
+ */
+
+/* You can override the default Infima variables here. */
+:root {
+  --ifm-color-primary: #2e8555;
+  --ifm-color-primary-dark: #29784c;
+  --ifm-color-primary-darker: #277148;
+  --ifm-color-primary-darkest: #205d3b;
+  --ifm-color-primary-light: #33925d;
+  --ifm-color-primary-lighter: #359962;
+  --ifm-color-primary-lightest: #3cad6e;
+  --ifm-code-font-size: 95%;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+}
+
+/* For readability concerns, you should choose a lighter palette in dark mode. */
+[data-theme='dark'] {
+  --ifm-color-primary: #25c2a0;
+  --ifm-color-primary-dark: #21af90;
+  --ifm-color-primary-darker: #1fa588;
+  --ifm-color-primary-darkest: #1a8870;
+  --ifm-color-primary-light: #29d5b0;
+  --ifm-color-primary-lighter: #32d8b4;
+  --ifm-color-primary-lightest: #4fddbf;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+}