gradio/website
Ali Abdalla 0dbc8bfcf3
Embedding Components on Docs (#1726)
* add component code to demos docker files

* fix demo_name

* frontend

* fix demo-name in frontend

* remove built with gradio

* remove extra space

* styling

* wait till page loads

* fixing components that require more parameters

* remove print statements

* check for correct run file

* combining component demos to one file

* typo

* fixes

* suffix name

* add is_component

Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
2022-07-19 16:20:20 +01:00
..
demos Embedding Components on Docs (#1726) 2022-07-19 16:20:20 +01:00
homepage Embedding Components on Docs (#1726) 2022-07-19 16:20:20 +01:00
.gitignore
docker-compose.yml Live website changes (#1578) 2022-07-06 16:22:10 -07:00
gradio.nginx.conf fix gradio web embeds 2021-12-22 08:45:23 +00:00
package-lock.json
README.md Live website changes (#1578) 2022-07-06 16:22:10 -07:00
reload_website.sh Live website changes (#1578) 2022-07-06 16:22:10 -07:00
reload_with_notification.sh fixing env var (#1043) 2022-04-20 20:04:30 +02:00

The Gradio Website

The Gradio website (https://gradio.app) is built from the contents of this folder. The website is tightly coupled with the rest of the repository through several ways:

  • The gradio library used to run the demos throughout the website is built from the library in the gradio folder of this repository
  • The demos are loaded from the gradio/demo folder
  • The guide pages are loaded from the gradio/guides folder
  • The documentation is loaded from the docstrings in the library itself.

The website is launched through the docker-compose.yml file in this directory.

You can run the entire website by:

  • Installing nginx
  • Copying gradio.nginx.conf from this folder to /etc/nginx/conf.d/gradio.nginx.conf
  • Running docker-compose build && docker-compose up
  • (Re)starting nginx

This will serve the website on port 80 (you can change the port from the gradio.nginx.conf file)

Alternatively, for development, read the homepage section below:

The homepage docker

The homepage folder builds the static content of the website into standalone files, served by nginx in docker. For development purposes, instead of running docker to test changes, follow these steps in the gradio/website/homepage folder.

  • npm install
  • npm run build (or npm run build-mac on Mac OSX)

The website will be built in the gradio/website/homepage/build directory. You can run a development server from this directory to launch the homepage, e.g. python -m http.server. See gradio/website/homepage/package.json for build steps.

The demos docker

The demos folder launches all the demos embedded inside the website. The demos are loaded from the gradio/demo folder.

Auto-Reloading

The website is built from the main branch and automatically reloads on commits to main.