From 5facd4a90189cab6767f81bacb29712d6a724715 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E0=B4=95=E0=B5=81=E0=B4=9F=E0=B5=8D=E0=B4=9F=E0=B5=82?= =?UTF-8?q?=E0=B4=B8=E0=B5=8D?= Date: Fri, 3 Jan 2025 21:19:56 +0100 Subject: [PATCH] use alert style in GitHub markdown for notes --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6a24b14..57c819e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,8 @@ This is the official documentation of the CircuitVerse simulator. This is meant ## Cloning Instructions -> **Note :** If you want to contribute, first fork the original repository and clone the forked repository into your local machine followed by `cd` into the directory +> [!NOTE] +> **If you want to contribute, first fork the original repository and clone the forked repository into your local machine followed by `cd` into the directory** ```sh git clone https://github.com//CircuitVerseDocs.git @@ -25,7 +26,8 @@ To view the docs in offline mode, navigate to `/docs` folder and run When you add a page, make sure you have an entry in the `_sidebar.md` -**Note :** **All the documentation should have a corresponding live circuit embedded so as to help the users. Also, the live circuit is NOT the same as image of a circuit.** +> [!NOTE] +> **All the documentation should have a corresponding live circuit embedded so as to help the users. Also, the live circuit is NOT the same as image of a circuit.** ## Installation on Netlify 1. Go to [https://app.netlify.com](https://app.netlify.com) and register an account