DocThemeIndigo.jl

The Documenter Theme for the ChainRules family of prackages. But you can use it too
Author JuliaDiff
Popularity
2 Stars
Updated Last
1 Year Ago
Started In
April 2021

DocThemeIndigo

Stable Dev Build Status Coverage

The Indigo theme for Documenter.

Installation

DocThemeIndigo is a   Julia Language   package. To install DocThemeIndigo, please open Julia's interactive session (known as REPL) and press ] key in the REPL to use the package mode, then type the following command

pkg> add DocThemeIndigo

Usage

  1. use DocThemeIndigo.install to generate the indigo CSS file
  2. put the CSS file path into your assets

Your docs/make.jl file would look like the following

using Documenter
using DocThemeIndigo

# 1. generate the indigo theme css
indigo = DocThemeIndigo.install(MyPackageModule)

makedocs(;
    # ...
    format=Documenter.HTML(;
        # ...
        # put your indigo css in assets
        assets=String[indigo #= your other assets =#],
    ),
    # ...
)

Acknowledgement

This theme is based on earlier works made by the following people: ChainRulesCore#332.

License

MIT License

Used By Packages

No packages found.