Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koooooo-7/docsify-corner
:seedling: A docsify plugin for corner configuration enhancement.
https://github.com/koooooo-7/docsify-corner
Last synced: 5 days ago
JSON representation
:seedling: A docsify plugin for corner configuration enhancement.
- Host: GitHub
- URL: https://github.com/koooooo-7/docsify-corner
- Owner: Koooooo-7
- License: mit
- Created: 2020-08-08T15:34:24.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T19:35:57.000Z (9 days ago)
- Last Synced: 2024-10-30T05:01:03.130Z (8 days ago)
- Language: JavaScript
- Homepage:
- Size: 123 KB
- Stars: 18
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# docsify-corner
*A [Docsify](https://docsify.js.org/) plugin for corner configuration enhancement based on [Docsify repo configuration](https://docsify.js.org/#/configuration?id=repo).*
- [x] support more icon ( `Gitlab`...）.
- [x] support customized image（`png`、`jpg`、`gif`）.
- [x] support more settings（`tooltip`、`color`）.
[](https://www.jsdelivr.com/package/npm/docsify-corner)
## Usage
### Import
Import one of the script in `index.html`.
```html
```
```html
```
### 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 |
```html
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",
},
};
```
---
#### Use the customized image
You can set your own image in the corner.
```html
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
},
};
```
---
### 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](https://gitlab.com/gitlab-org/gitlab-svgs) 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](https://github.com/Koooooo-7)