diff options
| author | Justin Wernick <justin@worthe-it.co.za> | 2023-06-09 13:49:21 +0200 |
|---|---|---|
| committer | Justin Wernick <justin@worthe-it.co.za> | 2023-06-09 13:49:21 +0200 |
| commit | cb35325c16760721e55783c4624ee63daa973f7c (patch) | |
| tree | 86b93ef1af032737a097ce2acdf4c10fa77f9091 | |
| parent | c3557a37cc9e4d23db0f14f669e72c7aaff5d4c1 (diff) | |
Update JSDoc to include a readme
| -rw-r--r-- | .jsdocrc.json | 12 | ||||
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | package.json | 2 |
3 files changed, 18 insertions, 4 deletions
diff --git a/.jsdocrc.json b/.jsdocrc.json new file mode 100644 index 0000000..99d9401 --- /dev/null +++ b/.jsdocrc.json @@ -0,0 +1,12 @@ +{ + "source": { + "include": "./", + "includePattern": ".js$" + }, + "plugins": ["plugins/markdown"], + "opts": { + "recurse": false, + "destination": "./dist/docs/", + "readme": "./README.md" + } +} @@ -142,7 +142,8 @@ var isSouthAfricanCitizen = saIdParser.parseIsSouthAfricanCitizen(validIdNumber) ## Releases -See [CHANGELOG.md](./CHANGELOG.md) for release notes. +See [CHANGELOG.md](https://codeberg.org/worthe-it/south-african-id-parser/src/branch/main/CHANGELOG.md) +for release notes. Releases are also available on [NPM](https://www.npmjs.com/package/south-african-id-parser) and @@ -163,8 +164,9 @@ and dependencies will be kept up to date. ## Contributing -See [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on setting up a -development environment to make changes and submit contributions. +See [CONTRIBUTING.md](https://codeberg.org/worthe-it/south-african-id-parser/src/branch/main/CONTRIBUTING.md) +for instructions on setting up a development environment to make changes and +submit contributions. ## Support diff --git a/package.json b/package.json index bc15702..b66f554 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "scripts": { "pretest": "eslint ./", "test": "mocha", - "docs": "jsdoc *.js --destination dist/docs" + "docs": "jsdoc --configure .jsdocrc.json" }, "keywords": [ "South Africa", |