github-md-catalog

generate catalog in Github readme page

Version vom 30.09.2020. Aktuellste Version

Du musst eine Erweiterung wie Tampermonkey, Greasemonkey oder Violentmonkey installieren, um dieses Skript zu installieren.

You will need to install an extension such as Tampermonkey to install this script.

You will need to install an extension such as Tampermonkey or Violentmonkey to install this script.

You will need to install an extension such as Tampermonkey or Userscripts to install this script.

You will need to install an extension such as Tampermonkey to install this script.

Sie müssten eine Skript Manager Erweiterung installieren damit sie dieses Skript installieren können

(Ich habe schon ein Skript Manager, Lass mich es installieren!)

You will need to install an extension such as Stylus to install this style.

You will need to install an extension such as Stylus to install this style.

You will need to install an extension such as Stylus to install this style.

You will need to install a user style manager extension to install this style.

You will need to install a user style manager extension to install this style.

You will need to install a user style manager extension to install this style.

(I already have a user style manager, let me install it!)

// ==UserScript==
// @name         github-md-catalog
// @namespace    http://tampermonkey.net/
// @version      0.1
// @description  generate catalog in Github readme page
// @author       fengxxc
// @match        https://github.com/*
// @grant        none
// ==/UserScript==

(function() {
    'use strict';

    function main() {
        // 目录树缩进的步长
        const PADDINGLEFT_STEP_LENGTH = 20;

        if (window.location.hostname != 'github.com') return;
        const mdDom = document.querySelector('article.markdown-body');
        if (!mdDom) return;
        let catalogs = [];
        const titles = mdDom.querySelectorAll('h1,h2,h3,h4,h5,h6');
        for (let i = 0; i < titles.length; i++) {
            catalogs.push(
                getPaddingLeftEl(parseInt(titles[i].tagName.slice(1)), PADDINGLEFT_STEP_LENGTH)
                + '<a href="#' + titles[i].innerText + '">' + titles[i].innerText + '</a><br>'
            );
            titles[i].insertAdjacentHTML('afterbegin', '<a name="' + titles[i].innerText + '"></a>');
        }
        document.body.insertAdjacentHTML('beforeend', '<nav id="github_md_catalog" style="position: fixed; top: 115px; right: 5px; max-width: 257px">' + catalogs.join('') + '</nav>');
    }

    function getPaddingLeftEl(tabStep, stepLength) {
        return '<span style="display: inline-block; width: ' + tabStep * stepLength + 'px;"></span>';
    }

    main();
})();