@jaex/dstsx 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -0
- package/dist/index.cjs +265 -166
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +42 -10
- package/dist/index.d.ts +42 -10
- package/dist/index.js +264 -166
- package/dist/index.js.map +1 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -2050,6 +2050,16 @@ To publish new versions of `dstsx`, follow the workflow below:
|
|
|
2050
2050
|
4. For local manual publishes you can run `npm publish`; `prepublishOnly` runs
|
|
2051
2051
|
the test suite and builds automatically.
|
|
2052
2052
|
|
|
2053
|
+
### Documentation site
|
|
2054
|
+
|
|
2055
|
+
* API docs are generated via TypeDoc – run `npm run docs` to rebuild the
|
|
2056
|
+
`./docs` directory. Any markdown pages you add under `docs/` are included in
|
|
2057
|
+
the sidebar, thanks to the `includes` setting in `typedoc.json`.
|
|
2058
|
+
* A little CSS file (`docs/typedoc.css`) is automatically injected so you can
|
|
2059
|
+
tweak colours, fonts, or other layout details.
|
|
2060
|
+
* The GitHub Action in `.github/workflows/docs.yml` will rebuild & publish the
|
|
2061
|
+
site to GitHub Pages on every push to `main`.
|
|
2062
|
+
|
|
2053
2063
|
Contributions are welcome! Please open issues or pull requests against the
|
|
2054
2064
|
GitHub repository.
|
|
2055
2065
|
|