docsify-top-banner-plugin
Get a pretty banner probably used for notifying announcements and updates
Donation
Installation
Add the following stylesheet along with your other stylesheets
And add the following script
Configure
In your docsify config object add the following
window$docsify = ...topBanner: options...
Options
content
Type : String
Default : none
It is the content which will be render as the top banner
NOTE: it should be a single line content
NOTE: It cant be empty! leaving empty will simply render an empty banner
defaultTag
Type : String
Default : 'span'
the html tag which will be added in the DOM to render the banner
position
Type : String
Default : 'fixed'
This is the banner's CSS position
property.
backgroundColor
Type : String
Default : '#deebff'
The background color of the banner
zIndex
Type : String
Default : 99
The z-index
of the banner
Recommended : Use position
relative
andzIndex
=-1
when you have repo config in your docsify
textColor
Type : String
Default : '#091E42'
The primary text color of the banner
linkColor
Type : String
Default : value of textColor
The primary text color of the anchor tag inside the banner
textAlign
Type : String
Default : center
Alignment of the content of the banner
Screen Shot
Contribution Guide
- Clone the repo
- start editing on
src/index.js
andsrc/style.styl
- The build step using
- the
styl -> css
usingstyl
CLI - Optimize the generated style using
cssnano
andpostcss
- Build the javascript using
rollup
- optimize it using
rollup-plugin-terser
- styling rule using
standard
- the