diff --git a/.github/workflows/generate-api-docs.yml b/.github/workflows/generate-api-docs.yml index 7925f53..4272898 100644 --- a/.github/workflows/generate-api-docs.yml +++ b/.github/workflows/generate-api-docs.yml @@ -5,7 +5,7 @@ on: types: [created] jobs: - build_and_lint: + publish_docs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 diff --git a/README.md b/README.md index 16bd5d5..393009e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # esbuild-quickstart +[Example API documentation](https://gyng.github.io/esbuild-quickstart/) + Quickstart for esbuild library projects. Depends on `yarn`. - Typescript @@ -41,6 +43,15 @@ Build targets are set in `esbuild.js`. 3. Update the `scope` key in `./github/workflows/publish.yml` to your GitHub (organisation) name +4. Configure GitHub Pages + + ``` + https://github.com/gyng/esbuild-quickstart/settings/pages + ``` + + - Source: `gh-pages` branch + - Directory: `/ (root)` + ### Run 1. Bump your version number in `package.json` before this. Publishing will fail if the version already exists. @@ -52,3 +63,5 @@ Build targets are set in `esbuild.js`. ``` The workflow at `./github/workflows/publish.yml` should run and publish your packages to both NPM and GitHub Packages. + + Also, API documentation will be published to your GitHub pages via the `gh-pages` branch. It will be viewable at `https://$YOUR_NAME.github.io/$YOUR_REPO/`. diff --git a/package.json b/package.json index 5573ca9..666bbfa 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@gyng/esbuild-quickstart", - "version": "1.1.0", + "version": "1.2.0", "main": "lib/cjs/index.js", "module": "lib/esm/index.js", "types": "lib/types/index.d.ts",