Skip to content

Commit

Permalink
chore: fix docs website (#3261)
Browse files Browse the repository at this point in the history
* chore: upgrade docusaurus & add copy codeblock

* fix broken link at faq/actions.md

* remove yarn.lock
  • Loading branch information
endiliey authored and markerikson committed Dec 8, 2018
1 parent c11b037 commit 96934e9
Show file tree
Hide file tree
Showing 5 changed files with 99 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/faq/Actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ No. We suggest you write independent small reducer functions that are each respo

**Documentation**

- [Basics: Reducers](/docs/basics/Reducers.md)
- [Basics: Reducers](../basics/Reducers.md)
- [Recipes: Structuring Reducers](../recipes/StructuringReducers.md)

**Discussions**
Expand Down
2 changes: 1 addition & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@
"@babel/preset-react": "^7.0.0"
},
"dependencies": {
"docusaurus": "^1.6.0"
"docusaurus": "^1.6.2"
}
}
16 changes: 13 additions & 3 deletions website/siteConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,26 @@ const siteConfig = {
},

// Add custom scripts here that would be placed in <script> tags.
scripts: ["/scripts/sidebarScroll.js"],
scripts: [
"/scripts/sidebarScroll.js",
"/scripts/codeblock.js",
"https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
],

// Add custom stylesheets here
stylesheets: ['/css/codeblock.css'],

// Last update time
enableUpdateTime: true,

// On page navigation for the current documentation page.
onPageNav: "separate",
// No .html extensions for paths.
cleanUrl: true,

// Open Graph and Twitter card images.
ogImage: "img/docusaurus.png",
twitterImage: "img/docusaurus.png",
ogImage: "img/redux.svg",
twitterImage: "img/redux.svg",

// You may provide arbitrary config keys to be used as needed by your
// template. For example, if you need your repo's URL...
Expand Down
39 changes: 39 additions & 0 deletions website/static/css/codeblock.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/* "Copy" code block button */
pre {
position: relative;
}

pre .btnIcon {
position: absolute;
top: 4px;
z-index: 2;
cursor: pointer;
border: 1px solid transparent;
padding: 0;
color: #fff;
background-color: transparent;
height: 30px;
transition: all .25s ease-out;
}

pre .btnIcon:hover {
text-decoration: none;
}

.btnIcon__body {
align-items: center;
display: flex;
}

.btnIcon svg {
fill: currentColor;
margin-right: .4em;
}

.btnIcon__label {
font-size: 11px;
}

.btnClipboard {
right: 10px;
}
45 changes: 45 additions & 0 deletions website/static/scripts/codeblock.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
window.addEventListener('load', function() {
function button(label, ariaLabel, icon, className) {
const btn = document.createElement('button');
btn.classList.add('btnIcon', className);
btn.setAttribute('type', 'button');
btn.setAttribute('aria-label', ariaLabel);
btn.innerHTML =
'<div class="btnIcon__body">' +
icon +
'<strong class="btnIcon__label">' +
label +
'</strong>' +
'</div>';
return btn;
}

function addButtons(codeBlockSelector, btn) {
document.querySelectorAll(codeBlockSelector).forEach(function(code) {
code.parentNode.appendChild(btn.cloneNode(true));
});
}

const copyIcon =
'<svg width="12" height="12" viewBox="340 364 14 15" xmlns="http://www.w3.org/2000/svg"><path fill="currentColor" d="M342 375.974h4v.998h-4v-.998zm5-5.987h-5v.998h5v-.998zm2 2.994v-1.995l-3 2.993 3 2.994v-1.996h5v-1.995h-5zm-4.5-.997H342v.998h2.5v-.997zm-2.5 2.993h2.5v-.998H342v.998zm9 .998h1v1.996c-.016.28-.11.514-.297.702-.187.187-.422.28-.703.296h-10c-.547 0-1-.452-1-.998v-10.976c0-.546.453-.998 1-.998h3c0-1.107.89-1.996 2-1.996 1.11 0 2 .89 2 1.996h3c.547 0 1 .452 1 .998v4.99h-1v-2.995h-10v8.98h10v-1.996zm-9-7.983h8c0-.544-.453-.996-1-.996h-1c-.547 0-1-.453-1-.998 0-.546-.453-.998-1-.998-.547 0-1 .452-1 .998 0 .545-.453.998-1 .998h-1c-.547 0-1 .452-1 .997z" fill-rule="evenodd"/></svg>';

addButtons(
'.hljs',
button('Copy', 'Copy code to clipboard', copyIcon, 'btnClipboard'),
);

const clipboard = new ClipboardJS('.btnClipboard', {
target: function(trigger) {
return trigger.parentNode.querySelector('code');
},
});

clipboard.on('success', function(event) {
event.clearSelection();
const textEl = event.trigger.querySelector('.btnIcon__label');
textEl.textContent = 'Copied';
setTimeout(function() {
textEl.textContent = 'Copy';
}, 2000);
});
});

0 comments on commit 96934e9

Please sign in to comment.