From 8d93a44566f5748ad6b7143beda86640e309eec2 Mon Sep 17 00:00:00 2001 From: Lea Verou Date: Wed, 4 Dec 2024 17:17:26 -0500 Subject: [PATCH] =?UTF-8?q?Revert=20edit,=20turns=20out=20code=20previews?= =?UTF-8?q?=20are=20already=20documented=20in=20the=20linked=20page=20?= =?UTF-8?q?=F0=9F=A4=A6=F0=9F=8F=BD=E2=80=8D=E2=99=80=EF=B8=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a4b08b8d..34ea8f77c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,21 +3,3 @@ Before contributing, please review the contributions guidelines at: [webawesome.com/docs/resources/contributing](https://webawesome.com/docs/resources/contributing) - -## Website Architecture - -### Code Examples - -`/docs/_utils/code-examples.js` is a small 11ty plugin that turns the code examples into previews. It relies on a client-side script of the same name that lives in /docs/assets/scripts and gets loaded into the site’s template. - -That takes care of rendering standard code blocks. It supports certain modifier classes: -- `example`: opts a code snippet in to live demo rendering -- `no-edit`: removes the codepen button -- `open`: shows the code snippet by default - -Modifier classes are used like this: -``` -```html {.example .no-edit .open} -``` - -That will render an example without the CodePen button and with the code already shown.