Awesome
docsify-corner
A Docsify plugin for corner configuration enhancement based on Docsify repo configuration.
- support more icon (
Gitlab
...). - support customized image(
png
、jpg
、gif
). - support more settings(
tooltip
、color
).
Usage
Import
Import one of the script in index.html
.
<script src="//cdn.jsdelivr.net/npm/docsify-corner/dist/docsify-corner.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-corner/dist/docsify-corner.min.js"></script>
Configuration
Options:
Option | Description |
---|---|
icon | the icon you want show the corner. |
url | the url for corner link to. |
target | the url target for corner link to. |
width | the width of the customized image. |
height | the height of the customized image. |
color | the color of the icon. |
background | the background color of the customized icon. |
title | the text of the title attribute is displayed as a tooltip. |
Use the preset icons
Current support default corner types.
Support Icon Type | Icon argument |
---|---|
Github | github |
Gitlab | gitlab |
Spring | spring |
Golang | golang |
<script>
window.$docsify = {
repo:'true', // set the docsify show the corner
corner: {
// the icon link url to another site
url: "https://gitlab.com/gitlab-org/gitlab-svgs",
// the default preset icon in docsify-corner
icon: "gitlab",
},
};
</script>
Use the customized image
You can set your own image in the corner.
<script>
window.$docsify = {
repo:'true',
corner: {
url: "https://github.com/Koooooo-7/docsify-corner",
// you can set the image link here
icon: "https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png",
// the size of the image
width: 80,
height: 80
},
};
</script>
Contribution
It is hard to adjust the icon to fit the corner, if you wanna add more preset icons, welcome star and send a PR!
This the current svg icon resources I' m working on.
Steps :
- Folk it !
- Install dependencies
npm install
. - Create your feature branch:
git checkout -b my-new-feature
. - Commit your changes:
git commit -am 'Add some feature'.
- Push to the branch:
git push origin my-new-feature
. - Submit a pull request.
License
MIT @Koy