Skip to content

Docs - Add comments and improve some UI areas in the docs #343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 7, 2021
Merged

Docs - Add comments and improve some UI areas in the docs #343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 76 additions & 10 deletions __DOC_RESOURCES__/customStyles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,56 +6,94 @@ Custom CSS for the JSDOC template
display:none;
}

/*body {*/
/* font-size:18px;*/
/*}*/

/**
Set colors to cloudinary theme
*/
.page-header {
background-color: #3448C5 !important;
}

/**
Set colors to cloudinary theme
*/
.breadcrumb li a {
color: #FF5050!important;
}

/**
Set colors to cloudinary theme
*/
.toc .nav>li.active>a, .toc .nav>li.active>a:focus, .toc .nav>li.active>a:hover {
color: #FF5050!important;
border-left: 2px solid #3448C5!important;
}

/**
Set colors of buttons to cloudinary theme
*/
.symbol-title .name-signature, .symbol-title .signature-params {
color: #0c163b!important;
}

/**
Set colors of buttons to cloudinary theme
*/
.back-to-top {
color: #5A616A!important;
}

/**
make function names bold
*/
.symbol-title.collapsible-symbol.function .name {
font-weight: bold;
text-decoration: underline;
}

/**
Set colors of buttons to cloudinary theme
*/
.symbol-title.collapsible-symbol .toggle-icon {
color: #3448C5!important;
text-indent: 0!important;
}

/**
Set colors to cloudinary theme
*/
.callout-primary {
border-left-color: #3448C5!important;
}

/**
Set colors to cloudinary theme
*/
.callout-primary h5 {
color: #3448C5!important;
}

/**
Set colors to cloudinary theme
*/
body {
color: #0c163b!important;
}

/**
Set colors to cloudinary theme
*/
.toc .nav>li>a .name-signature, .toc .nav>li>a .signature-params {
color: #0c163b!important;
}

/**
Set colors to cloudinary theme
*/
.callout-default {
border-left-color: #5A616A!important;
}

/**
Set sizes to cloudinary theme
*/
.branding-logo {
background-size:30px;
}
Expand Down Expand Up @@ -128,13 +166,11 @@ body {
* ENSURE ALL COLLAPSABLE AREAS ARE ALWAYS OPEN
*/
.symbol-details {
max-height:9999px!important;
/*max-height:9999px!important;*/
}

.symbol-title.function {
padding: 10px;
border: 1px solid black;
border-radius:2px;
/*padding: 0px;*/
}

/**
Expand Down Expand Up @@ -165,3 +201,33 @@ body {
.pill-legend {
padding-bottom:15px;
}



/**
Hide the <static> prefix in method names
*/
.signature-attribs {
display:none;
}

/**
Make the description and details sections of a function smaller
*/
.callout {
padding: 13px;
}
/**
Hide the Return statement of methods
*/
.callout-success {
display:none;
}

/**
Reduce spaces between horizontal lines
*/
.hr {
margin-top: 10px;
margin-bottom: 10px;
}
2 changes: 1 addition & 1 deletion src/actions/border.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class Border extends Action {
* @summary action
* @memberOf Actions.Border
* @description Sets the style of the border.
* @return {Actions.Border}
* @return {Border}
*/
static solid(width: number | string, color: SystemColors): Border {
return new Border('solid', color, width);
Expand Down