Skip to content
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.

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

Docs/tidy html file #926

Closed
wants to merge 33 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
40c94a6
delete old images
Joseph-Perkins Dec 10, 2024
1628e14
add new images
Joseph-Perkins Dec 10, 2024
8758fe7
update README
Joseph-Perkins Dec 10, 2024
c4b4a33
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 10, 2024
3cc536a
Ignore git folder for codespell
huong-li-nguyen Dec 11, 2024
70ee1c0
Simplify html code
huong-li-nguyen Dec 11, 2024
53a9c82
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
628f30a
Fix
huong-li-nguyen Dec 11, 2024
b157c05
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
5e9180e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
f28c724
Check if we can center image directly
huong-li-nguyen Dec 11, 2024
d7592f1
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
0bad920
Lint
huong-li-nguyen Dec 11, 2024
1929ac9
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
e1d1942
Check how it looks like
huong-li-nguyen Dec 11, 2024
fccfe8e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
7420898
Merge branch 'main' into docs/tidy-html-file
huong-li-nguyen Dec 11, 2024
4dfa9a3
Check if it looks terrible
huong-li-nguyen Dec 11, 2024
5a186e8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
7017451
Check if it looks better
huong-li-nguyen Dec 11, 2024
2c28baf
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
3550633
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
ee436a6
Simplify layout
huong-li-nguyen Dec 11, 2024
a4e5624
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
dc65015
Lint
huong-li-nguyen Dec 11, 2024
4832b8a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
d4a1cd4
Simplify
huong-li-nguyen Dec 11, 2024
781334e
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
7c80280
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
89f4dd2
Tidy
huong-li-nguyen Dec 11, 2024
66dba56
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
f0cc40b
Make images bigger
huong-li-nguyen Dec 11, 2024
3b891e9
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
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
Prev Previous commit
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
pre-commit-ci[bot] committed Dec 11, 2024
commit 3b891e98483fd7efc9f377361903ab4bdbf7eee3
14 changes: 4 additions & 10 deletions vizro-core/README.md
Original file line number Diff line number Diff line change
@@ -22,7 +22,6 @@
<img src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/logo_watermarks.svg" width="300">
</div>


## What is Vizro?

Vizro is an open-source Python-based toolkit.
@@ -47,7 +46,6 @@ The benefits of the Vizro toolkit include:

Visit our ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features.


## Why use Vizro?

Vizro helps you to build data visualization apps that are:
@@ -86,46 +84,42 @@ Use Vizro when you need to combine the speed and ease of low-code Python tools,

### [Vizro framework](https://vizro.readthedocs.io/en/stable/)

**Low-code framework for building dashboards**
**Low-code framework for building dashboards**

The Vizro framework underpins the entire Vizro toolkit. It is a Python package (called `vizro`).

Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more details.


### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/)

**Chart examples**
**Chart examples**

The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code to create these charts with Plotly or embed them into a Vizro dashboard.

Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration.

<img width="600" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_visual_vocabulary.png">


### [Vizro examples gallery](https://vizro.mckinsey.com/)

**Dashboard examples**
**Dashboard examples**

The dashboard examples gallery enables you to explore Vizro in action by viewing interactive example apps. You can copy the code to use as a template or starter for your next dashboard.

Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the dashboards in action.

<img width="600" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_dashboard_examples.png">


### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai)

**LLM generated charts and dashboards**
**LLM generated charts and dashboards**

Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorporate LLMs. Use it to build interactive Vizro charts and dashboards, by simply describing what you need in plain English or other languages.

Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details.

<img width="600" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_vizro_ai.gif">


## Installation and first steps

```console