[BUG] Inconsistent table formatting #709
Description
Overview of the issue
The table formatting on Components vs Injectables vs Interfaces all look different.
Methods of Injectable Table
It has 4 columns. The Description column is incorrectly rendered as code. This should be text.
Inputs of Component Table
It has only 2 columns. 2nd column has data stacked on top of itself instead of using new columns like Methods table. Description here is not rendered as code.
Properties of Interface Table
This table has only 1 column. Not sure why. The "domain: string" is redundant because "domain" appears above and "type: string" appears below.
I think these tables should have a more consistent look and layout. Each page of the documentation requires mental effort to decipher the pattern displayed there. It would be less effort if there was just one pattern for the user to learn to recognize.
Operating System, Node.js, npm, compodoc version(s)
Windows 10
Node 10.14.1
npm 6.4.1
Angular configuration, a package.json file in the root folder
package.json
{
"name": "gallery",
"version": "0.0.0",
"scripts": {
"ng": "ng",
"start": "npm run compodoc && npm run styleguide && ng serve --port 4210",
"build": "ng build",
"test": "ng test",
"lint": "ng lint",
"e2e": "ng e2e",
"watch-styleguide": "npx watch \"kss --config kss-config.json\" ../framework/framework/styles/",
"styleguide": "npx kss --config kss-config.json",
"compodoc": "./node_modules/.bin/compodoc -p ../framework/framework/tsconfig.lib.json -w --theme material --hideGenerator --disableSourceCode --disablePrivate --disableLifeCycleHooks --minimal --name \"Dynatron Front End Framework\" -d \"src/generated/compodoc\"",
"compodoc-serve": "./node_modules/.bin/compodoc -p ../framework/framework/tsconfig.lib.json -s -w --theme material --hideGenerator --disableSourceCode --disablePrivate --disableLifeCycleHooks --name \"Dynatron Front End Framework\""
},
"private": true,
"dependencies": {
"@angular/animations": "~7.1.0",
"@angular/cdk": "~7.1.0",
"@angular/common": "~7.1.0",
"@angular/compiler": "~7.1.0",
"@angular/core": "~7.1.0",
"@angular/flex-layout": "^7.0.0-beta.19",
"@angular/forms": "~7.1.0",
"@angular/material": "^7.1.0",
"@angular/platform-browser": "~7.1.0",
"@angular/platform-browser-dynamic": "~7.1.0",
"@angular/router": "~7.1.0",
"@dynatron/framework": "file:../framework/dist/framework",
"@dynatron/schematics": "file:../schematics",
"angular-gauge": "^3.1.1",
"core-js": "^2.5.4",
"hammerjs": "^2.0.8",
"ngx-highlight-js": "^2.1.1",
"ngx-markdown": "^7.0.2",
"ngx-toastr": "^9.1.1",
"rxjs": "~6.3.3",
"tslib": "^1.9.0",
"zone.js": "~0.8.26"
},
"devDependencies": {
"@angular-devkit/build-angular": "~0.11.0",
"@angular/cli": "~7.1.0",
"@angular/compiler-cli": "~7.1.0",
"@angular/language-service": "~7.1.0",
"@compodoc/compodoc": "^1.1.6",
"kss": "^3.0.0-beta.23",
"tslint": "~5.11.0",
"typescript": "~3.1.6",
"watch": "^1.0.2"
}
}
Compodoc installed globally or locally ?
locally
If possible sourcecode of the file where it breaks
If possible your terminal logs before the error
Motivation for or Use Case
These tables look inconsistent. Let's format them the same.
Reproduce the error
Observe docs for Component
Observe docs for Injectable
Observe docs for Interface
Notice the tables look completely different.