Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use alert style in GitHub markdown for notes #387

Merged
merged 1 commit into from
Jan 14, 2025
Merged

use alert style in GitHub markdown for notes #387

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<your-username>/CircuitVerseDocs.git
Expand All @@ -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
Expand Down
Loading