dracula/tmux

Enhancement: documentation

Opened this issue · 4 comments

I would like to write documenation for all the optional flags that can be set for this plugin. i'm thinking of a docs directory with a markdown file for each individual feature, though possibly grouping things like the gpu features.

before putting in the effort to write all this however, i would like to know if that is something that would be merged if done well.
please let me know and i'll get to work :D

Yes. I think it is much needed.

aight, on it :D

Yep ! and there’s an error on the Dracula website.

The Continuum options section is under Kubernetes. It would be helpful to clarify that it’s not a plugin, and that Continuum and Resurrect are required as dependencies

i am still working on the documentation, which you can follow here:
https://github.com/Theoreticallyhugo/dracula-tmux/tree/feature/docs/docs

a bunch of things are not done, or not included yet.

additionally, im planning on picking up #224. as a part of that i'd like to add colour customisation to more places, as well as putting the variables in a separate file, allowing for easily using fully custom colours. i will be adding these features over time, whilst documenting them too.