jsdoc.conf.json 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. {
  2. "opts": {
  3. "encoding": "utf8", // same as -e utf8
  4. "destination": "./o2web/jsdoc/", // same as -d ./out/
  5. "recurse": true, // same as -r
  6. "template" : "./node_modules/better-docs"
  7. //"template": "templates/default" // same as -t templates/default
  8. // "tutorials": "path/to/tutorials" // same as -u path/to/tutorials
  9. },
  10. "tags": {
  11. "allowUnknownTags": ["optional"]
  12. },
  13. "source": {
  14. "include": ["./o2web/source/x_component_process_Xform"],
  15. "includePattern": "\\.(jsx|js|ts|tsx)$",
  16. "excludePattern": "(^|\\/|\\\\)_"
  17. },
  18. "plugins": [
  19. "plugins/markdown",
  20. "plugins/summarize",
  21. "./node_modules/better-docs/typescript"
  22. ],
  23. "templates": {
  24. "cleverLinks": false,
  25. "monospaceLinks": false,
  26. "dateFormat": "YYYY-MM-dd",
  27. "outputSourceFiles": true,
  28. "outputSourcePath": true,
  29. "systemName": "O2前台组件API",
  30. "footer": "",
  31. "copyright": "o2 group",
  32. "navType": "vertical",
  33. "theme": "readable", //readable lumen cosmo
  34. "linenums": true,
  35. "collapseSymbols": false,
  36. "inverseNav": true,
  37. "protocol": "html://",
  38. "methodHeadingReturns": false
  39. },
  40. "markdown": {
  41. "parser": "gfm",
  42. "hardwrap": true
  43. }
  44. }
  45. //执行命令: jsdoc -c ./o2web/jsdoc.conf.json