Skip to content

Add an example

Louis-Maxime Piton edited this page Oct 23, 2024 · 8 revisions

To add an example, please follow the steps :

  • Add your <EXAMPLE> in site/data/examples.yml
  • Place your files in site/content/docs/5.2/examples/<EXAMPLE>/, name the html file index.html
  • Add 2 pictures that fit the final page state:
    • Take a screenshot that fits:
      • Resolution: 1920px width and 1200px height
    • Resize the image (website):
      • A first time to 960x600, rename it <EXAMPLE>@2x.png
      • A second time to 480x300, rename it <EXAMPLE>.png
    • Compress the images.
      • Via ILoveImg for all pictures.
      • Via Oxipng for .pngs using oxipng -omax -Z *.png.
      • Via jpegoptim for JPEG files (used upstream).
    • Place these renamed pictures in site/static/docs/{docs_version}/assets/img/examples/

That's it 🎉

Clone this wiki locally