Skip to content

Jday1/update docs #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jday1 merged 3 commits into from
Feb 11, 2026
Merged

Jday1/update docs #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9d7edd3
Update README to use urls for images so it renders on pypi.
Feb 11, 2026
aedab93
Update README to use urls for images so it renders on pypi.
Feb 11, 2026
e000ed1
Revert version.
Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![Title](docs/title_logo.svg)
![Title](https://raw.githubusercontent.com/jday1/plotlylogomaker/main/docs/title_logo.svg)

The repository for plotlylogomaker. A python project for making logos in plotly similar to [logomaker](https://github.com/jbkinney/logomaker/tree/master/logomaker).
plotlylogomaker is inspired by the work of Kevin Kovalchik which is available on [GitHub](https://github.com/kevinkovalchik/Plotly-Logo).
A python project for making logos in plotly similar to [logomaker](https://github.com/jbkinney/logomaker/tree/master/logomaker).
plotlylogomaker is inspired by the work of [Kevin Kovalchik](https://github.com/kevinkovalchik/Plotly-Logo).

## Example

Expand Down Expand Up @@ -84,17 +84,17 @@ fig.write_image(PLOTLYLOGOMAKER_PATH / "singleplot_negative_frequencies.svg")
<details>
<summary><strong>Single Plot Logo example</strong></summary>

![Single Plot Logo example](docs/single_plot_example.svg)
![Single Plot Logo example](https://raw.githubusercontent.com/jday1/plotlylogomaker/main/docs/single_plot_example.svg)
</details>
<details>
<summary><strong>Subplot Logo example</strong></summary>

![Subplot Logo example](docs/subplot_example.svg)
![Subplot Logo example](https://raw.githubusercontent.com/jday1/plotlylogomaker/main/docs/subplot_example.svg)
</details>
<details>
<summary><strong>Single Plot Logo with negative frequencies example</strong></summary>

![Single Plot Logo with negative frequencies example](docs/singleplot_negative_frequencies.svg)
![Single Plot Logo with negative frequencies example](https://raw.githubusercontent.com/jday1/plotlylogomaker/main/docs/singleplot_negative_frequencies.svg)
</details>

## Color Schemes
Expand All @@ -105,5 +105,4 @@ Three color schemes are defined in plotlylogomaker.color:
- Chemical Groups
- Nucleotides

One can define their own color scheme using the plotlylogomaker.color.ColorScheme class.
Currently, all alphabet letters can be used as keys.
Users can define custom color schemes via the plotlylogomaker.color.ColorScheme class, where alphabet letters serve as the keys.