Giter VIP home page Giter VIP logo

docsify-plugin-giscus's Introduction

docsify-plugin-giscus

This docsify plugin places giscus as the last child element of <article class="markdown-section" id="main">.

NPM Version

Usage notes

Stylesheet

<!-- head -->
<link rel="stylesheet" href="https://unpkg.com/@mingchyuanko/docsify-plugin-giscus/dist/giscus.css">

Script

<!-- body -->
<script src="https://unpkg.com/@mingchyuanko/docsify-plugin-giscus/dist/giscus.min.js"></script>

Configure docsify-plugin-giscus

https://giscus.app/

    <script>
        window.$docsify = {
            giscus: {
                repo: "ENTER REPO HERE",
                repoId: "ENTER REPO ID HERE",
                category: "ENTER CATEGORY NAME HERE",
                categoryId: "ENTER CATEGORY ID HERE",
                reactionsEnabled: "1",
                inputPosition: "top",
                theme: "noborder_light",
                lang: "zh-TW",
                loading: true,
            },
        };
    </script>

theme

  • Type: string

You can use:

theme: "https://unpkg.com/@mingchyuanko/docsify-plugin-giscus/dist/noborder_light_custom.css",

It's just a slight modification of the original file, as there was an issue with the border in the comments section being obscured in the original style.

loading

  • Type: boolean

Loading of the comments will be deferred until the user scrolls near the comments container.

docsify-plugin-giscus's People

Contributors

mingchyuan avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.