mirror of
https://github.com/gradio-app/gradio.git
synced 2024-11-27 01:40:20 +08:00
63d0a28c08
* adding gallery * added netlify files * new navbar design * header section new design * used by section new design * cards section new design * integrates with section new design * customer stories section new design * footer and gradient * demos section new design * docs fixes * docs reorg * docs reorg * upgrading to tailwind 3 * tailwind config changes * navbar new design * fixing body on all pages * Updating Guides (#1012) * updating getting started * updated codecov version * tweaks to gs * added netlify file * added netlify file * website prebuild script * increased code size * blocks * edits * blocks_hello * hello world * guide * merge main * added flipper demo * guide * guide * add guides * tweak to refresh website * header section new design * demos section new design * cards design * used by section * tweets section * footer on all pages * mobile responsive fixes * mobile responsive fixes * https fonts * completed blocks guide * unify components * minor tweaks * docs headers styling and navigation pane * parameter code blocks * styling description and input type * parameter tables and other styling * only documenting interactive components when possible * guides * embedding not working * demos not working * fixing demo code * fixing demos * demo fix * updated demos * updated demos * ui update * updated docstrings * updated code snippets so they run * updating docs * Interface docs * updating interface * fixing parameters in interface.py * required and defaults for interface, and styling * fixing up interface (#1207) * fixing up interface * fixed interface methods * formatting * updating interface docs * updating interface docs * formatting * docstring to load from docstrings * fixed colors * finalize interface content * interface examples * fixed examples * added some blocks docs * blocks * component fixes * reorganized some files (#1210) * formatting * added info for every component * fixes * blocks docs * added blocks demos * adding combined interfaces * added parallel, series * Doc: layout update (#1216) * doc layout * home spacing Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * adding layouts * layouts done * added events for components * formatting and https * brings back dropdown and other components * fix header ids * moved ids and fixed nav * added parameters for remaining component * docstring fixes * landing page demos * demo window placeholder * demo nav * fixed test * formatting * demo code * correctly importing gradio css/js * remove keyvalues * modify launch script to move gradio assetS * components embedded test * correct demo name * hide try demo and embedding * local devserver changes * create embedding json with configs * changes * fixes * comment out layout docs * demo work * demo fixes * demo embedding fixes * typo * jinja fix * demo nav fix * hide demo button * formatting * removed whitespace * remove newline from parameter * reverting comments Co-authored-by: aliabd <ali.si3luwa@gmail.com> Co-authored-by: Victor Muštar <victor.mustar@gmail.com> Co-authored-by: Ali Abid <aabid94@gmail.com> |
||
|---|---|---|
| .. | ||
| adding_rich_descriptions_to_your_demo.md | ||
| building_a_pictionary_app.md | ||
| create_your_own_friends_with_a_gan.md | ||
| creating_a_chatbot.md | ||
| getting_started.md | ||
| Gradio_and_ONNX_on_Hugging_Face.md | ||
| image_classification_in_pytorch.md | ||
| image_classification_in_tensorflow.md | ||
| image_classification_with_vision_transformers.md | ||
| introduction_to_blocks.md | ||
| README.md | ||
| real_time_speech_recognition.md | ||
| using_flagging.md | ||
| using_hugging_face_integrations.md | ||
| using_the_api_docs.md | ||
Contributing a Guide
Want to help teach Gradio? Consider contributing a Guide! 🤗
Broadly speaking, there are two types of guides:
- Use cases: guides that cover step-by-step how to build a particular type of machine learning demo or app using Gradio. Here's an example: Creating a Chatbot
- Feature explanation: guides that describe in detail a particular feature of Gradio. Here's an example: Using Flagging
We encourage you to submit either type of Guide! (Looking for ideas? We may also have open issues where users have asked for guides on particular topics)
Guide Structure
As you can see with the previous examples, Guides are standard markdown documents. They usually:
- start with an Introduction section describing the topic
- include subheadings to make articles easy to navigate
- include real code snippets that make it easy to follow along and implement the Guide
- include embedded Gradio demos to make them more interactive and provide immediate demonstrations of the topic being discussed. These Gradio demos are hosted on Hugging Face Spaces and are embedded using the standard <iframe> tag.
How to Contribute a Guide
- Clone or fork this
gradiorepo - Add a new markdown document with a descriptive title to the
/guidesfolder - Write your Guide in standard markdown! Embed Gradio demos wherever helpful
- Add a list of
related_spacesat the top of the markdown document (see the previously linked Guides for how to do this) - Add 3
tagsat the top of the markdown document to help users find your guide (again, see the previously linked Guides for how to do this) - Open a PR to have your guide reviewed
That's it! We're looking forward to reading your Guide 🥳