https://github.com/boopathikumar018/docsify-darklight-theme

A Dark and Light theme with switch for your docsify site
https://github.com/boopathikumar018/docsify-darklight-theme

customizable docsify-darklight-theme docsify-site docsify-themeable theme-switcher

Last synced: about 2 months ago
JSON representation

A Dark and Light theme with switch for your docsify site

• Host: GitHub
• URL: https://github.com/boopathikumar018/docsify-darklight-theme
• Owner: boopathikumar018
• License: mit
• Created: 2020-03-27T18:53:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-04T23:06:01.000Z (12 months ago)
• Last Synced: 2024-07-19T03:45:47.881Z (2 months ago)
• Topics: customizable, docsify-darklight-theme, docsify-site, docsify-themeable, theme-switcher
• Language: CSS
• Homepage: https://docsify-darklight-theme.boopathikumar.me
• Size: 4.37 MB
• Stars: 140
• Watchers: 3
• Forks: 48
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        



    

         

    



 

    docsify-darklight-theme

    



     Docs | Preview





    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    



 Dark and Light theme with switch for your docsify site




     view starter template installation guide



# What it is

**docsify-darklight-theme**  is a simple and highly customizable theme for the documentation websites generated using [docsify.js](https://docsify.js.org/) ( also with [docsify-themeable](https://jhildenbiddle.github.io/docsify-themeable/#/) ). Using this theme, documents will have a theme switcher to switch between  `dark-mode` and  `light-mode` .

See the [Quick start](https://docsify-darklight-theme.boopathikumar.me/#/installation) guide for more details.

# Features

- Default [theme mode detection](https://docsify-darklight-theme.boopathikumar.me/#/configuration?id=default-browser-theme-detection) in supported browser versions.

- Theme Switcher.

- Switcher support for [docsify-themeable](https://jhildenbiddle.github.io/docsify-themeable/#/). View [setup guide](https://docsify-darklight-theme.boopathikumar.me/#/docsifyThemeable) here.

- Themes are customizable based on your color preferences.

- Option for other plugins to support (Dark/Light) mode. View [setup guide](https://docsify-darklight-theme.boopathikumar.me/#/themeSupport) here.

- Preferences can be modified directly in `window.$docsify` [configuration object](https://docsify-darklight-theme.boopathikumar.me/#/configuration).

- Using [configuration object](https://docsify-darklight-theme.boopathikumar.me/#/configuration)toogle icons can be configured based on your preference.

- Default theme(Dark/Light) can be configured based on your needs.

- Themes are remembered and retrieved from local storage.

- Redesigned search box.

# Contributors

[@boopathikumar](//boopathikumar.me) [@eswarijayakumar](https://github.com/eswarijayakumar) [@kumaravel](//kumaravel.me)

# Showcase

Check out the [Showcase](https://docsify-darklight-theme.boopathikumar.me/#/showcase) to see **docsify-darklight-theme** with docsify in use.

# Release notes

View the [Change log](https://docsify-darklight-theme.boopathikumar.me/#/changelog) to know the details of each versions.

# Support

- Create a [GitHub issue](https://github.com/boopathikumar018/docsify-darklight-theme/issues) for bug reports, feature requests, or questions

- Follow [@docsify-darklight-theme](https://twitter.com/docsifyDrkLtThm) for announcements and release updates.

- Add a ⭐️ [star on GitHub](https://github.com/boopathikumar018/docsify-darklight-theme) to support the plugin!

# License

This project is licensed under the terms of the [MIT](https://github.com/boopathikumar018/docsify-darklight-theme/blob/master/LICENSE) license.

 © [Boopathi Kumar](https://boopathikumar.me)