diff --git a/README.md b/README.md index cb57ead..f213f69 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ esparto [![codecov](https://codecov.io/gh/domvwt/esparto/branch/main/graph/badge.svg?token=35J8NZCUYC)](https://codecov.io/gh/domvwt/esparto) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=domvwt_esparto&metric=alert_status)](https://sonarcloud.io/dashboard?id=domvwt_esparto) -Esparto is a minimal frontend web framework written in Python. -It aims to be the first choice for designing self-contained documents with productivity as the main concern. +Esparto is a super minimal frontend web framework written in Python. Its primary use is for generating shareable single page documents +with content from popular analytics and data science libraries. -Full documentation available at [domvwt.github.io/esparto/](https://domvwt.github.io/esparto/). +Full documentation and examples at [domvwt.github.io/esparto/](https://domvwt.github.io/esparto/). ### Features * Lightweight API @@ -18,3 +18,11 @@ Full documentation available at [domvwt.github.io/esparto/](https://domvwt.githu * Self contained / inline dependencies * Jupyter Notebook support * MIT License + +## Supported Content +* Markdown text +* Images +* Matplotlib figures +* Pandas DataFrames +* Bokeh objects +* Plotly figures diff --git a/docs/01-getting-started/esparto-image-screenshot.png b/docs/01-getting-started/esparto-image-screenshot.png index ef1453e..ba17312 100644 Binary files a/docs/01-getting-started/esparto-image-screenshot.png and b/docs/01-getting-started/esparto-image-screenshot.png differ diff --git a/docs/01-getting-started/esparto-quickstart-screenshot.png b/docs/01-getting-started/esparto-quickstart-screenshot.png index 6b38d36..5aaca84 100644 Binary files a/docs/01-getting-started/esparto-quickstart-screenshot.png and b/docs/01-getting-started/esparto-quickstart-screenshot.png differ diff --git a/docs/01-getting-started/quickstart.md b/docs/01-getting-started/quickstart.md index be8731d..352d89d 100644 --- a/docs/01-getting-started/quickstart.md +++ b/docs/01-getting-started/quickstart.md @@ -29,7 +29,7 @@ my_page.save("esparto-quick.html") The rendered HTML document: - +
@@ -45,7 +45,7 @@ Your *content* goes **here!** """ my_page += content_md -my_page += "../notebooks/iris-virginica.jpg" +my_page += "image.jpg" html = my_page.save("esparto-quick-image.html") ``` @@ -53,7 +53,7 @@ html = my_page.save("esparto-quick-image.html") Esparto determines that the string points to a valid image and loads the file: - +
diff --git a/docs/02-user-guide/examples.md b/docs/02-user-guide/examples.md index c07e4f6..a5811f4 100644 --- a/docs/02-user-guide/examples.md +++ b/docs/02-user-guide/examples.md @@ -27,7 +27,7 @@ with few lines of code. With the [Plotly backend for Pandas](https://plotly.com/python/pandas-backend/) we can access the Plotly Express API directly from the '.plot()' method of any DataFrame or Series. -This example will show basic examples from each library: +This notebook shows basic examples from each library: * Interactive plotting with Bokeh and Plotly * Adding interactive content to the page diff --git a/docs/index.md b/docs/index.md index 1cb542c..fbdcd77 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Welcome -Esparto is a minimal frontend web framework written in Python. -It aims to be the first choice for designing self-contained documents with productivity as the main concern. +Esparto is a super minimal frontend web framework written in Python. Its primary use is for generating shareable single page documents +with content from popular analytics and data science libraries. ## Overview The library provides a streamlined API that lets users define their page in terms of @@ -26,10 +26,7 @@ and iteratively build documents without disrupting their workflow. * Self contained / inline dependencies * MIT License - -## Integrations -The following content types are currently supported - +## Supported Content * Markdown text * Images * Matplotlib figures