diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index b22ff332..6f6f6640 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -22,3 +22,14 @@ jobs: with: {name: dist, path: dist} - name: test run: npm ci && npm test + - name: generate documentation + # We need the symbolic links to avoid breaking old URLs + run: npm run doc && mkdir -p documentation/class && ln -s documentation/* documentation/class/ + - name: Update github pages + if: github.event_name == 'push' && github.ref == 'refs/heads/master' + uses: JamesIves/github-pages-deploy-action@3.6.2 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: gh-pages # The branch the action should deploy to. + FOLDER: "." # The folder the action should deploy. + CLEAN: false # Automatically remove deleted files from the deploy branch diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/README.md b/README.md index 6cec1802..8f0f2d7e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# SQLite compiled to JavaScript + + +# SQLite compiled to JavaScript [![CI status](https://github.com/sql-js/sql.js/workflows/CI/badge.svg)](https://github.com/sql-js/sql.js/actions) [![npm](https://img.shields.io/npm/v/sql.js)](https://www.npmjs.com/package/sql.js) @@ -271,7 +273,9 @@ Although asm.js files were distributed as a single Javascript file, WebAssembly -## Versions of sql.js included in the [distributed artifacts](https://github.com/sql-js/sql.js/releases/latest) +## Versions of sql.js included in the distributed artifacts +You can always find the latest published artifacts on https://github.com/sql-js/sql.js/releases/latest. + For each [release](https://github.com/sql-js/sql.js/releases/), you will find a file called `sqljs.zip` in the *release assets*. It will contain: - `sql-wasm.js` : The Web Assembly version of Sql.js. Minified and suitable for production. Use this. If you use this, you will need to include/ship `sql-wasm.wasm` as well. - `sql-wasm-debug.js` : The Web Assembly, Debug version of Sql.js. Larger, with assertions turned on. Useful for local development. You will need to include/ship `sql-wasm-debug.wasm` if you use this. diff --git a/index.html b/index.html index 7dea987e..69dbe996 100644 --- a/index.html +++ b/index.html @@ -1,28 +1,21 @@ - - - - sql.js - - - -

sql.js

- -

Examples

- -
    -
  1. Online SQL Interpreter Full featured Sqlite Interpreter running in your browser.
    2. -
  2. Online SQL read eval print loop simple SQLite REPL
    3. -
  3. Persistence Persisting data
    4. -
  4. RequireJS Load sql.js asynchronously using RequireJs
    5. -
  5. Simple Example Demonstrates prepare,getAsObject, and other SQL.js methods.
    6. -
- -Note: To run these examples locally, see ./examples/readme.md - -

Source

- -

Source on Github

- - - - + + + + + + sql.js + + + + + + + +
+ + + + + \ No newline at end of file