☰

npmjs.com visual tweaks

Makes READMEs on npmjs.com look more like READMEs on GitHub (font, size, padding, some colors); also makes the content wider

Fra 07.07.2018. Se den seneste versjonen.

  1. // ==UserScript==
  2. // @name         npmjs.com visual tweaks
  3. // @namespace    http://tampermonkey.net/
  4. // @version      0.7.13
  5. // @description  Makes READMEs on npmjs.com look more like READMEs on GitHub (font, size, padding, some colors); also makes the content wider
  6. // @author       joeytwiddle
  7. // @copyright    2018, Paul "Joey" Clark (http://neuralyte.org/~joey)
  8. // @license      MIT
  9. // @match        https://www.npmjs.com/*
  10. // @grant        GM_addStyle
  11. // ==/UserScript==
  12.  
  13. // Motivation: I didn't like the visual context switching between reading Github READMEs and npm READMEs, so I made READMEs on npm look similar to READMEs on Github.
  14.  
  15. (function() {
  16.     'use strict';
  17.  
  18.     // This allows the README to expand to the full width below the info sidebar
  19.     const floatTheSidebar = true;
  20.  
  21.     // I want to scale down the fonts and everything else a bit.  This was an easy way to do that.
  22.     //GM_addStyle('.container { transform: scale(0.92); transform-origin: 50% 0; }');
  23.  
  24.     // Fill (almost) the whole width of the screen, like Wide-Github does.
  25.     //GM_addStyle('.container { width: 98%; max-width: 100%; }');
  26.     GM_addStyle(".vistweaks #top { max-width: 100%; }");
  27.     // OK not the entire width.  Stop the width when it starts to look ugly.
  28.     GM_addStyle(".vistweaks #top { max-width: 1500px; }");
  29.  
  30.     // Set fonts like GitHub
  31.     GM_addStyle('.vistweaks #readme { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Source Sans Pro", "Lucida Grande", sans-serif; }');
  32.     GM_addStyle('#readme { font-family: line-height: 1.5;}');
  33.     //GM_addStyle('pre, code, kbd, samp { font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace; }');
  34.     // Set fonts how I like them (configurable through browser)
  35.     //GM_addStyle('pre, code, kbd, samp { font-family: monospace; }');
  36.     // I don't know why, but "monospace" shrinks the font considerably on my Linux, whilst "monospace,monospace" does not.
  37.     // Also "monospace,monospace" is what the site itself adopted on 2018/3/22.  This rule will just ensure it stays this way!
  38.     GM_addStyle('.vistweaks .readme__readme___tmT33 pre, .vistweaks .readme__readme___tmT33 code, .vistweaks .readme__readme___tmT33 kbd, .vistweaks .readme__readme___tmT33 samp { font-family: monospace,monospace; }');
  39.  
  40.     // Set font sizes like GitHub
  41.     GM_addStyle('.vistweaks .readme__readme___tmT33 p { font-size: 16px; line-height: 1m5; }');
  42.     GM_addStyle(`
  43.         /*
  44.         @media screen and (min-width: 30em) {
  45.           .vistweaks .readme__readme___tmT33 {
  46.             font-size: 0.8rem;
  47.           }
  48.         }
  49.         */
  50.         .vistweaks .readme__readme___tmT33 h1 {
  51.             padding-bottom: 0.3em;
  52.             font-size: 2em;
  53.             border-bottom: 1px solid #eaecef
  54.         }
  55.         .vistweaks .readme__readme___tmT33 h2 {
  56.             padding-bottom: 0.3em;
  57.             font-size: 1.5em;
  58.             border-bottom: 1px solid #eaecef
  59.         }
  60.         .vistweaks .readme__readme___tmT33 h3 {
  61.             font-size: 1.25em
  62.         }
  63.         .vistweaks .readme__readme___tmT33 h4 {
  64.             font-size: 1em
  65.         }
  66.         .vistweaks .readme__readme___tmT33 h5 {
  67.             font-size: 0.875em
  68.         }
  69.         .vistweaks .readme__readme___tmT33 h6 {
  70.             font-size: 0.85em;
  71.             color: #6a737d
  72.         }
  73.         /* Code blocks inside a header do not shrink */
  74.         .vistweaks .readme__readme___tmT33 h1 tt,
  75.         .vistweaks .readme__readme___tmT33 h1 code,
  76.         .vistweaks .readme__readme___tmT33 h2 tt,
  77.         .vistweaks .readme__readme___tmT33 h2 code,
  78.         .vistweaks .readme__readme___tmT33 h3 tt,
  79.         .vistweaks .readme__readme___tmT33 h3 code,
  80.         .vistweaks .readme__readme___tmT33 h4 tt,
  81.         .vistweaks .readme__readme___tmT33 h4 code,
  82.         .vistweaks .readme__readme___tmT33 h5 tt,
  83.         .vistweaks .readme__readme___tmT33 h5 code,
  84.         .vistweaks .readme__readme___tmT33 h6 tt,
  85.         .vistweaks .readme__readme___tmT33 h6 code {
  86.             font-size: inherit;
  87.             /* This is a fix because 600 is not thick enough for the monospace font we introduced */
  88.             /* font-weight: 800; */
  89.             /* Using the Github mandated font is a better fix */
  90.             font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  91.         }
  92.     `);
  93.     // A snippet of code appearing within a paragraph
  94.     // A line of code on its own
  95.     GM_addStyle('.vistweaks .readme__readme___tmT33 pre { line-height: 1.5; }');
  96.     GM_addStyle('.vistweaks .readme__readme___tmT33 code { line-height: 1.5; }');
  97.     GM_addStyle('.vistweaks .readme__readme___tmT33 pre { font-size: 85%; }');
  98.     GM_addStyle('.vistweaks .readme__readme___tmT33 code { font-size: 85%; }');
  99.     GM_addStyle('.vistweaks .readme__readme___tmT33 pre code { font-size: inherit; }');
  100.     // A block of code
  101.     //GM_addStyle('.vistweaks pre { font-size: 82%; line-height: 1.4; }');
  102.  
  103.     // Darker text
  104.     if (navigator.userAgent.match(/Mac OS X/)) {
  105.         // Weirdly, on Mac, the font strokes on npmjs.com appear slightly thinner than those on Github, for a reason I cannot understand.  To compensate, I use a darker color.
  106.         GM_addStyle('.vistweaks .markdown p, .vistweaks .markdown li { color: #111; }');
  107.     } else {
  108.         // Github 2016 (my preference)
  109.         GM_addStyle('.vistweaks .markdown p, .vistweaks .markdown li { color: #333; }');
  110.         // Github 2017
  111.         //GM_addStyle('.markdown p, .markdown li { color: #24292e; }');
  112.     }
  113.  
  114.     // The boxes around inline code snippets
  115.     GM_addStyle('.vistweaks code { border-radius: 3px; padding: 0.2em 0.4em !important; }');
  116.  
  117.     // Links should be normal weight (npm makes them bolder)
  118.     GM_addStyle('.vistweaks .markdown p a, .vistweaks .markdown li a { font-weight: initial; }');
  119.  
  120.     // Padding around code blocks and snippets
  121.     // A snippet of code appearing within a paragraph
  122.     GM_addStyle('.vistweaks code { padding: 0.2em 0.2em; }');
  123.     // A line of code on its own
  124.     GM_addStyle('.vistweaks pre > code { padding: 1em 2em; }');
  125.  
  126.     // Reduce the large padding inside code blocks to be more like Github's
  127.     GM_addStyle('.vistweaks pre { padding: 1.1rem !important; }');
  128.  
  129.     // Lighter background on code blocks and snippets
  130.     GM_addStyle('.vistweaks .markdown .highlight, .vistweaks .markdown code, .vistweaks .markdown pre { background-color: #f6f8fa; }');
  131.  
  132.     // More of a gap after each paragraph?  Wasn't actually needed.  The problem was wrapping due to insufficient width.
  133.     //GM_addStyle('div, .highlight { padding-bottom: 20px; }');
  134.  
  135.     // Thicker font for section headers
  136.     GM_addStyle('.vistweaks .markdown h1, .vistweaks .markdown h2, .vistweaks .markdown h3, .vistweaks .markdown h4, .vistweaks .markdown h5, .vistweaks .markdown h6 { font-weight: 600; }');
  137.  
  138.     // Use the npm font for section headers, even though we aren't using it for main text.  (This is a divergence from Github's markdown scheme.)
  139.     //GM_addStyle(".markdown h1, .markdown h2, .markdown h3, .markdown h4, .markdown h5, .markdown h6 { font-family: 'Source Sans Pro', 'Lucida Grande', sans-serif; }");
  140.  
  141.     // There was absolutely no padding on the new styling.  At low widths, the text could touch the edge of the screen.  No thanks!
  142.     //GM_addStyle(".markdown { padding-left: 1em; padding-right: 1em; }");
  143.     // Better to do it for the whole content, including the tabs across the top
  144.     //GM_addStyle("#top { padding-left: 1em; padding-right: 1em; }");
  145.     // At larger widths we can enjoy greater padding
  146.     GM_addStyle(".vistweaks #top { padding-left: 2%; padding-right: 2%; }");
  147.  
  148.     // Make the sidebar look like a hovering card
  149.     // Sadly this now reaches all the way down to the bottom of the README
  150.     GM_addStyle(".vistweaks .package__rightSidebar___9dMXo { padding: 0.9em 1.8em 0.1em 1.8em !important; margin-top: 2.75rem; }");
  151.     //GM_addStyle(".package__rightSidebar___9dMXo { box-shadow: 0 0 8px 0 #00000033; }");
  152.     GM_addStyle(".vistweaks .package__rightSidebar___9dMXo { border: 1px solid #0002 }");
  153.     // This widens the gap between the two panels, so the shadow doesn't overlap too much
  154.     GM_addStyle(".vistweaks .markdown { padding-right: 0.5em; }");
  155.     // This graph does not scale down well to low resolutions, with or without our changes.  I will wait and see if they fix that.
  156.  
  157.     // This is one way of increasing the specificity of our selectors
  158.     // It could also be used to toggle our tweaks on and off
  159.     // But I have not yet added it to the selectors above
  160.     document.body.classList.add("vistweaks");
  161.  
  162.     // Drop the huge margins above section titles
  163.     GM_addStyle(".vistweaks .markdown h1, .vistweaks .markdown h2, .vistweaks .markdown h3, .vistweaks .markdown h4, .vistweaks .markdown h5, .vistweaks .markdown h6 { margin-top: 1em; padding-top: 0; }");
  164.  
  165.     // Indent lists
  166.     GM_addStyle(".vistweaks .markdown ul, .vistweaks .markdown ol { padding-left: 2em; }");
  167.  
  168.     if (floatTheSidebar) {
  169.         var checkTheSidebar = function () {
  170.             const mainLeftPanel = document.querySelector('.package__main___3By_B');
  171.             if (!mainLeftPanel) return;
  172.  
  173.             const readmeElement = document.querySelector('#readme');
  174.             if (!readmeElement) return;
  175.  
  176.             const sidebarElement = document.querySelector('.package__rightSidebar___9dMXo');
  177.             if (!sidebarElement) return;
  178.             if (sidebarElement.parentNode.classList.contains('visual-tweaks-userscript-sidebar-container')) {
  179.                 //console.log("We have already handled this sidebar");
  180.                 return;
  181.             }
  182.  
  183.             mainLeftPanel.classList.remove('w-two-thirds-l');
  184.             //mainLeftPanel.querySelector('section').classList.remove('mr3-ns');
  185.  
  186.             // If there is nothing forcing the main pane to fill the width, then it won't.
  187.             // That looks odd, because the floated sidebar will now not appear next to the right edge.
  188.             // Example (a page without an image): https://www.npmjs.com/package/eslint-plugin-styled-components
  189.             // So we force the main content to fill the available width.
  190.             mainLeftPanel.style.width = '100%';
  191.             mainLeftPanel.style.maxWidth = '100%';
  192.  
  193.             const sidebarContainer = document.createElement('div');
  194.             sidebarContainer.className = 'visual-tweaks-userscript-sidebar-container';
  195.             sidebarContainer.style.float = 'right';
  196.             sidebarContainer.style.background = 'white';
  197.             sidebarContainer.style.paddingLeft = '3em';
  198.             sidebarContainer.style.paddingBottom = '3em';
  199.             // Move the width from the sidebar to the container
  200.             sidebarElement.classList.remove('w-third-l');
  201.             sidebarContainer.classList.add('w-third-l');
  202.             sidebarContainer.appendChild(sidebarElement);
  203.             GM_addStyle(".vistweaks .markdown { padding-right: 0; }");
  204.             // Clear the existing margin.  Leave a small margin for the shadow.
  205.             GM_addStyle(".vistweaks .mr3-ns { margin-right: 4px; }");
  206.             // Give the info card equal padding at the top and bottom
  207.             GM_addStyle(".vistweaks .package__rightSidebar___9dMXo { padding-top: 1em !important; padding-bottom: 1em !important; }");
  208.             //readmeElement.appendChild(sidebarElement);
  209.             readmeElement.parentNode.insertBefore(sidebarContainer, readmeElement);
  210.  
  211.             // BUG: At low resolutions, normally the sidebar will break to below the readme.  But with our changes, the sidebar appears above the readme!
  212.  
  213.             // If an image appears above the fold, and it takes 100% of the width, then it will cause the document to push down below the floating sidebar
  214.             // For an example of such a page: https://www.npmjs.com/package/passport
  215.             // To fix it, we set a max width on images
  216.             // Of course this rule will apply to all images, even those later down on the page
  217.             // npmjs have now set their own max, so we can remove this
  218.             GM_addStyle(".vistweaks .markdown img { max-width: 66%; }");
  219.         };
  220.  
  221.         checkTheSidebar();
  222.  
  223.         // Keep checking, in case we go to a new page
  224.         new MutationObserver(mutations => checkTheSidebar()).observe(document.body, { childList: true, subtree: true });
  225.     }
  226. })();