Merge pull request #304 from sasjs/docsify

Docsify

Author: allanbowe

.gitignore

@@ -22,3 +22,7 @@ yarn-error.log*
 sasjsbuild/
 sasjsresults/
 .sasjsrc
+
+# temporary documentation sites
+public/docs/static/js
+public/docs/stastic/sas

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "public/docs"]
+	path = public/docs
+	url = git@github.com:sasjs/docs

.sasjslint

@@ -1,13 +1,13 @@
 {
-    "noTrailingSpaces": true,
-    "noEncodedPasswords": true,
-    "hasDoxygenHeader": true,
-    "hasMacroNameInMend": true,
-    "hasMacroParentheses": true,
-    "noNestedMacros": false,
-    "noSpacesInFileNames": true,
-    "maxLineLength": 230,
-    "lowerCaseFileNames": true,
-    "noTabIndentation": true,
-    "indentationMultiple": 2
-}
+  "noTrailingSpaces": true,
+  "noEncodedPasswords": true,
+  "hasDoxygenHeader": true,
+  "hasMacroNameInMend": true,
+  "hasMacroParentheses": true,
+  "noNestedMacros": true,
+  "noSpacesInFileNames": true,
+  "maxLineLength": 80,
+  "lowerCaseFileNames": true,
+  "noTabIndentation": true,
+  "indentationMultiple": 2
+}

package-lock.json

@@ -14,6 +14,8 @@
   "scripts": {
     "start": "npx webpack-dev-server --config webpack.dev.js --open --hot",
     "build": "npx webpack --config webpack.prod.js",
+    "docs": "typedoc --out ./public/docs/static/js && sasjs doc -t viya ",
+    "docs:serve": " docsify serve ./public/docs",
     "deploy": "rsync -avhe ssh ./build/* --delete $SSH_ACCOUNT:$DEPLOY_PATH",
     "buildAndDeploy": "npm run build && npm run deploy",
     "lint:fix": "npx prettier --write \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
@@ -26,9 +28,9 @@
     "@material-ui/lab": "^4.0.0-alpha.60",
     "@mui/icons-material": "^5.2.5",
     "@mui/material": "^5.2.6",
-    "@sasjs/adapter": "^3.4.1",
-    "@sasjs/core": "^3.9.0",
-    "@sasjs/utils": "^2.34.1",
+    "@sasjs/adapter": "3.7.0",
+    "@sasjs/core": "4.9.0",
+    "@sasjs/utils": "2.36.0",
     "axios": "^0.24.0",
     "moment": "^2.29.1",
     "react": "^17.0.2",
@@ -57,6 +59,7 @@
     "sass-loader": "^12.3.0",
     "style-loader": "^3.3.1",
     "ts-loader": "^9.2.6",
+    "typedoc": "0.22.12",
     "typescript": "^4.5.2",
     "webpack": "5.68.0",
     "webpack-cli": "4.9.1",

package.json

@@ -1,5 +1,12 @@
 {
   "$schema": "https://cli.sasjs.io/sasjsconfig-schema.json",
+  "docConfig": {
+    "enableLineage": true,
+    "doxyContent": {
+      "readMe": "../../README.md"
+    },
+    "outDirectory": "public/docs/static/sas"
+  },
   "macroFolders": [
     "sasjs/macros"
   ],

public/docs

@@ -0,0 +1,7 @@
+{
+  "entryPoints": [
+    "src/utils",
+    "src/components/abortModal.tsx"
+  ],
+  "out": "docs"
+}