clean-jsdoc-theme
Advanced tools
Comparing version 2.2.8 to 2.2.10
@@ -15,3 +15,3 @@ # Contributing | ||
## Any contributions you make will be under the MIT Software License | ||
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. | ||
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact at hello@ankdev.me if that's a concern. | ||
@@ -18,0 +18,0 @@ ## Creating issues |
@@ -8,3 +8,3 @@ { | ||
"./demo/src", | ||
"./README.md" | ||
"./README.md" | ||
] | ||
@@ -11,0 +11,0 @@ }, |
{ | ||
"name": "clean-jsdoc-theme", | ||
"version": "2.2.8", | ||
"version": "2.2.10", | ||
"description": "A beautifully crafted theme/template for JSDoc 3. This theme/template looks and feels like a premium theme/template. This is a fully mobile responsive theme and also fully customizable theme.", | ||
@@ -5,0 +5,0 @@ "main": "publish.js", |
# clean-jsdoc-theme | ||
[![Stars](https://img.shields.io/github/stars/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme) [![Fork](https://img.shields.io/github/forks/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/fork) ![Version](https://img.shields.io/badge/version-2.2.8-%23007bff) [![Issues Open](https://img.shields.io/github/issues/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues) [![Isses Closed](https://img.shields.io/github/issues-closed/ankitskvmdam/clean-jsdoc-theme?color=%234caf50)](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues?q=is%3Aissue+is%3Aclosed) [![Contributors](https://img.shields.io/github/contributors/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors) [![npm downloads](https://img.shields.io/npm/dt/clean-jsdoc-theme)](https://www.npmjs.com/package/clean-jsdoc-theme) [![Build Status](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme.svg?branch=production)](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme) [![lisence](https://img.shields.io/github/license/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE) [![Website Of/ficial](https://img.shields.io/website?up_message=official&url=https%3A%2F%2Fankdev.me%2Fclean-jsdoc-theme)](https://ankdev.me/clean-jsdoc-theme/index.html) [![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-hindi-%23007bff)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CODE_OF_CONDUCT_HINDI.md) [![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-english-%234caf50)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CODE_OF_CONDUCT.md) | ||
[![Stars](https://img.shields.io/github/stars/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme) [![Fork](https://img.shields.io/github/forks/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/fork) ![Version](https://img.shields.io/badge/version-2.2.10-%23007bff) [![Issues Open](https://img.shields.io/github/issues/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues) [![Isses Closed](https://img.shields.io/github/issues-closed/ankitskvmdam/clean-jsdoc-theme?color=%234caf50)](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues?q=is%3Aissue+is%3Aclosed) [![Contributors](https://img.shields.io/github/contributors/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors) [![npm downloads](https://img.shields.io/npm/dt/clean-jsdoc-theme)](https://www.npmjs.com/package/clean-jsdoc-theme) [![Build Status](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme.svg?branch=production)](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme) [![lisence](https://img.shields.io/github/license/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE) [![Website Of/ficial](https://img.shields.io/website?up_message=official&url=https%3A%2F%2Fankdev.me%2Fclean-jsdoc-theme)](https://ankdev.me/clean-jsdoc-theme/index.html) [![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-hindi-%23007bff)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CODE_OF_CONDUCT_HINDI.md) [![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-english-%234caf50)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CODE_OF_CONDUCT.md) | ||
<br> | ||
A beautifully crafted theme/template for JSDoc 3. We have built this theme/template to bring the best user experience. This theme/template looks and feels like a premium theme/template. This is a fully mobile responsive theme and also fully customizable theme (for more look below in <a href="#features">feature section</a>).<br> | ||
@@ -17,3 +15,3 @@ | ||
![Screen-3](./example/screen-3.png) | ||
![Screen-4](./example/screen-4.jpg) | ||
![Screen-4](./example/screen-4.png) | ||
@@ -20,0 +18,0 @@ ## Install |
@@ -0,9 +1,39 @@ | ||
function copy(value){ | ||
const el = document.createElement('textarea'); | ||
el.value = value; | ||
document.body.appendChild(el); | ||
el.select(); | ||
document.execCommand('copy'); | ||
document.body.removeChild(el); | ||
} | ||
function showTooltip(id){ | ||
var tooltip = document.getElementById(id); | ||
tooltip.classList.add('show-tooltip'); | ||
setTimeout(function(){ | ||
tooltip.classList.remove('show-tooltip'); | ||
}, 3000); | ||
} | ||
function copyFunction(id){ | ||
// selecting the pre element | ||
var code = document.getElementById(id); | ||
// selecting the code element of that pre element | ||
code = code.childNodes[0] | ||
// copy | ||
copy(code.innerText); | ||
// show tooltip | ||
showTooltip('tooltip-' + id); | ||
} | ||
(function(){ | ||
// capturing all pre element on the page | ||
var all_pre = document.getElementsByTagName("pre"); | ||
// template of copy to clipboard icon container | ||
var copy_to_clipboard = '<div class="code-copy-icon-container" id="click-copy"><svg class="sm-icon" alt="click to copy"><use xlink:href="#copy-icon"></use></svg></div>'; | ||
var i, lang_name, classList, lang_name_div; | ||
@@ -13,13 +43,24 @@ for( i = 0; i < all_pre.length; i++){ | ||
classList = all_pre[i].classList; | ||
var id = 'pre-id-' + i; | ||
// tooltip | ||
var tooltip = '<div class="tooltip" id="tooltip-'+ id +'">Copied!</div>'; | ||
// template of copy to clipboard icon container | ||
var copy_to_clipboard = '<div class="code-copy-icon-container" onclick="copyFunction(\''+ id +'\')"><div><svg class="sm-icon" alt="click to copy"><use xlink:href="#copy-icon"></use></svg>'+ tooltip +'<div></div>'; | ||
// extract the code language | ||
lang_name = classList[classList.length - 1].split('-')[1]; | ||
if( lang_name == undefined ) lang_name = 'JavaScript' | ||
if(lang_name != undefined) | ||
// if(lang_name != undefined) | ||
lang_name_div = '<div class="code-lang-name-container"><div class="code-lang-name">'+ lang_name.toLocaleUpperCase() +'</div></div>'; | ||
else lang_name_div = ''; | ||
// else lang_name_div = ''; | ||
// appending everythin to the current pre element | ||
all_pre[i].innerHTML += lang_name_div + copy_to_clipboard; | ||
all_pre[i].setAttribute('id', id); | ||
} | ||
})() |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
1956
997507
162