Skip to content

Commit

Permalink
minimal docs website (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
kylebarron authored Nov 30, 2023
1 parent 60fdf47 commit ba53b23
Show file tree
Hide file tree
Showing 5 changed files with 442 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
docs_build/

# Logs
logs
*.log
Expand Down
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
"scripts": {
"build": "rollup -c rollup.config.js",
"clean": "rimraf dist",
"docs:build": "typedoc",
"docs:publish": "gh-pages -d docs_build",
"fmt:check": "prettier './src/**/*.ts' --check",
"fmt": "prettier './src/**/*.ts' --write",
"prepublishOnly": "yarn clean && yarn build",
Expand All @@ -48,11 +50,13 @@
"@types/node": "^20.9.3",
"@types/proj4": "^2",
"apache-arrow": "^14",
"gh-pages": "^6.1.0",
"prettier": "^3.1.0",
"rimraf": "^5.0.5",
"rollup": "^4.1.5",
"rollup-plugin-dts": "^6.1.0",
"ts-node": "^10.9.1",
"typedoc": "^0.25.4",
"typescript": "^5.2.2",
"vitest": "^0.34.6"
},
Expand Down
3 changes: 3 additions & 0 deletions tsconfig.docs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"include": ["dist/**/*.d.ts"]
}
15 changes: 15 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "@geoarrow/geoarrow-js",
"cleanOutputDir": true,
"darkHighlightTheme": "github-dark",
"entryPoints": [
"dist/index.d.ts",
],
"lightHighlightTheme": "github-light",
"tsconfig": "tsconfig.docs.json",
"out": "docs_build",
"excludePrivate": true,
"excludeProtected": true,
"excludeExternals": true,
"includeVersion": true
}
Loading

0 comments on commit ba53b23

Please sign in to comment.