ANN: The Documenter Theme Indigo

I’m excited to announce the documenter theme Indigo: GitHub - JuliaDiff/DocThemeIndigo.jl: The Documenter Theme for the ChainRules family of prackages. But you can use it too

This is originally the theme ChainRules uses, I separate it out so that now we can use it for other packages.


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.

13 Likes