Skip to content

ChifiSource/OliveDocBrowser.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

- [documentation](https://chifidocs.com/olive/OliveDocBrowser) `OliveDocBrowser` is a Markdown documentation browser built directly into your `Olive` session! - Say hello to *one* tab of docs **and** *one* tab of code inside the same notebook!

## installing To 'quick install' this extension, use the `+` button in your `olive` home directory (hopefully you are root,) and enter `OliveDocBrowser`. (`OliveDocBrowser` in place of `OliveDefaults` below)

Alternatively, there are manual methods of installation, you can read more about these on ChifiDocs here and in the Olive README here. If you are using Olive .1.3 + then you can load OliveDocBrowser before calling start with using OliveDocBrowser.

usage

After installing the extension, resourcing your olive module (via the resource button or by restarting,) and refreshing the page there should be a new additional button on the topbar. Clicking this button will yield a new menu. At the top, we select modules to browse documentation for. For any nested modules that we want docs for, we simply export them to load them into this viewer.

About

documentation browser extension for olive

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Languages