1.4.1 • Published 6 years ago
@sentinel-one/ui-compodoc v1.4.1
Angular Document Generator
Installation
git clone git@github.com:Sentinel-One/ui-compodoc.git
npm i
Execute
npm run genDoc:dev
orgulp
npm run genDoc
orgulp --env=prod
File Structure
.
├── common * share logic\const\templates etc
│ └── gulp * share gulp utils\paths
│ ├── paths.js * gulp path for dev\prod
│ └── utils.js * gulp utils functionality
├── assets * screen shot\images
├── CHANGELOG.md * change log details
├── README.md * readme file
├── gulpfile.js * gulp task to generate component examples
├── package-lock.json * project dependencies
├── package.json * project dependencies
└── test * helper for dev
How to Doc
- add decorator
@ComponentDocExample({})
above@Component
- add the component into entryComponents array in
mgmt-ui.module.ts
- execute gulp task
- check the demo display
Example
@ComponentDocExample({
navItem: {
groupName: 'DATA TABLE',
exampleName: 'Pagination'
},
demos: [
{
title:'Example 1'
inputs: {
id: 'myId',
maxVisiblePages: 3,
totalServerEntities: 1000,
numOfEntityPerPage: 10,
showPreviousAndNextText: false
},
executeComponentMethod: 'init'
}
]
})
Publish to npm
- update package.json version
- push changes to git
- execute this command
npm publish --access public
Screen Shot
1.4.1
6 years ago
1.4.0
6 years ago
1.3.0
6 years ago
1.2.15
6 years ago
1.2.14
6 years ago
1.2.13
6 years ago
1.2.12
6 years ago
1.2.11
6 years ago
1.2.10
6 years ago
1.2.9
6 years ago
1.2.8
6 years ago
1.2.7
6 years ago
1.2.6
6 years ago
1.2.5
6 years ago
1.2.4
6 years ago
1.2.3
6 years ago
1.2.2
6 years ago
1.2.1
6 years ago
1.2.0
6 years ago
1.1.0
6 years ago
1.0.9
6 years ago
1.0.8
6 years ago
1.0.7
6 years ago
1.0.6
6 years ago
1.0.5
6 years ago
1.0.4
6 years ago
1.0.3
6 years ago
1.0.2
6 years ago
1.0.1
6 years ago
1.0.0
6 years ago