https://github.com/juliadiff/docthemeindigo.jl

The Documenter Theme for the ChainRules family of packages. But you can use it too
https://github.com/juliadiff/docthemeindigo.jl

Last synced: 3 days ago
JSON representation

The Documenter Theme for the ChainRules family of packages. But you can use it too

• Host: GitHub
• URL: https://github.com/juliadiff/docthemeindigo.jl
• Owner: JuliaDiff
• License: mit
• Created: 2021-04-07T19:47:24.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-11-18T05:11:44.000Z (7 months ago)
• Last Synced: 2025-05-30T04:56:01.054Z (about 1 month ago)
• Language: SCSS
• Homepage:
• Size: 116 KB
• Stars: 8
• Watchers: 6
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DocThemeIndigo

[![Build Status](https://github.com/JuliaDiff/DocThemeIndigo.jl/workflows/CI/badge.svg)](https://github.com/JuliaDiff/DocThemeIndigo.jl/actions)

[![Coverage](https://codecov.io/gh/JuliaDiff/DocThemeIndigo.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaDiff/DocThemeIndigo.jl)

[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)

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



```julia

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

```julia

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](https://github.com/JuliaDiff/ChainRulesCore.jl/issues/332).

- [@iamed2](https://github.com/iamed2)

- [@oxinabox](https://github.com/oxinabox)

- [@cormullion](https://github.com/cormullion)

- [@simeonschaub](https://github.com/simeonschaub)

## License

MIT License