Git Product home page Git Product logo

docsify-contributors's Introduction

docsify-contributors

npm version npm downloads

触发

afterEach()(文档解析完成)完毕后,在末尾插入容器元素;

doneEach() 中读取当前文件 commits,过滤出其中的贡献者,再加入容器当中。

效果

已使用该插件仓库站点:doocs/leetcode

demo

使用

添加 JS:

<script src="//cdn.jsdelivr.net/npm/docsify-contributors@latest/dist/index.min.js"></script>

参数:

window.$docsify = {
    contributors: {
        repo: 'YangFong/docsify-contributors',
        ignores: [],
        style: {
            color: '#ffffff',
            bgColor: '#404040'
        },
        image: {
            size: 30,
            isRound: true,
            margin: '0.5em'
        },
        load: {
            isOpen: true,
            color: "#009999"
        }
    }
};

配置

属性 类型 说明 默认值 示例
repo string 当前站点仓库信息(必填) —— "YangFong/docsify-contributors"
ignores string[] 需要忽略展示的文件 [] ['/README.md']
style {} 见下文
image {} 见下文
load {} 见下文

style

属性 类型 说明 默认值
color string 贡献者名称颜色 #ffffff
bgColor string 伪元素背景色 #404040

image

属性 类型 说明 默认值 示例
size number 头像大小尺寸 30
isRound boolean 是否使用圆形头像 true
margin string 头像外边距,使用 CSS 格式 0.5em 0 1em

load

1.7.0 新增,源自 react-loadingg

属性 类型 说明 默认值 示例
isOpen boolean 是否开启加载动画 false
color string 加载动画物块颜色 #009999

docsify-contributors's People

Contributors

yangfong avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  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.