New post check list

Jump to bottom

Holtz Yan edited this page Aug 12, 2023 · 6 revisions

This document gives advices to create a good blog post on the Python Graph Gallery.

See a good example here.

Metadata

✅ The notebook description has at least 3 sentences. (it appears on top of the page)
✅ The notebook description has a link to the parent section.

Titles

✅ At least 2 titles of level 2 (##)
✅ There is a section about libraries with link to the matplotlib, seaborn or plotly parent page.
✅ There is a section about the dataset being used
✅ Not more than ~40 characters for the title

Text

✅ use text formatting. Use bold for important things. Add links. Use bullet points if necessary.
✅ always include links to original author of a work you are using.
✅ always include links to other relevant sections of the python graph gallery.
✅ if the plot you build is complicated, split it in a step-by-step manner. Include intermediary charts.
✅ You can include emojis ❤️

Code

✅ indent your code. A line of code should not have more than ~100 characters
✅ comment your code. Above a code chunk. Next to it for a single line.

Plot

✅ use a proper figsize=(width, height) to make sure the plot fits the screen
✅ if plot is made from a dataset (csv, xlsx, json..) -> data file must be store in the data folder of the gallery
✅ if plot is made with Seaborn, use the darkgrid theme