https://github.com/roel4ez/docfx-lightbox-plugin

A small repository containing a template for DocFx to add lightbox effect for all images.
https://github.com/roel4ez/docfx-lightbox-plugin

Last synced: 3 months ago
JSON representation

A small repository containing a template for DocFx to add lightbox effect for all images.

• Host: GitHub
• URL: https://github.com/roel4ez/docfx-lightbox-plugin
• Owner: roel4ez
• License: mit
• Created: 2017-07-13T07:43:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-06-24T08:04:49.000Z (over 2 years ago)
• Last Synced: 2023-08-01T06:22:13.431Z (over 1 year ago)
• Language: C#
• Size: 1.49 MB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docfx-lightbox-plugin

A small repository containing a template for DocFx to add lightbox effect for all images. 

## Featherlight

The first version of this template uses the jQuery [Featherlight](https://noelboss.github.io/featherlight/) plugin. Therefore, there is a dependencies on both of these libraries.  

It is using the default template from `docfx` as a base template. 

jQuery and the featherlight libraries are loaded from the public CDN.

### Usage

To use this template, you need to add it to your repository in the `templates` folder, and add the following to your `docfx.json` file:

```json

   "template": [

      "default",

      "templates/lightbox-featherlight"

    ]

```

### Demo

A sample can be found in the `demo` folder. It uses a relative path to the `templates` folder. 

## Bootstrap modal

The second version of this plugin uses the Bootstrap Modal window, and is created by implementing `IPostProcessor`.