diff --git a/docs/chapter1/1introduction.md b/docs/chapter1/1introduction.md deleted file mode 100644 index 301dafbb..00000000 --- a/docs/chapter1/1introduction.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: chapter1-introduction -title: "Introduction" -description: "Introduction page in Chapter1 of CircuitVerse documentation." -slug : / ---- - -# Introduction - - - -Inspired by Logisim, CircuitVerse is an open-source educational tool for designing and visualizing digital logic circuit simulations in the cloud. Users including educators, students, electronic engineers, and hobbyists can play with digital circuit simulations from their browsers for exploring different “what-if” scenarios. As required, a user can share their creations using unique circuit URLs, or fork different contributions of the CircuitVerse community to yield their curiosity. Figure 1 shares a screenshot of a ripple carry adder simulation built using CircuitVerse. - -![](/img/img_chapter1/1.1.png) - -
- Figure 1.1: Ripple Carry Adder simulation built using CircuitVerse -
- -Developed for educators by educators, the CircuitVerse platform delivers high class learning experience in a scalable way. Educators can manage, track, and achieve their classroom learning goals in a single, powerful solution. They can create and manage different student groups, post different assignments, define submission deadlines and add or export grades (refer Figure 2). Using the CircuitVerse Chrome extension, educators can embed live circuits in their Google Slides and demonstrate concepts without navigating across different tabs. Alternatively, they can also export images or embed iFrames within their webpages. - -![](/img/img_chapter1/1.2.png) - -
- - Figure 1.2: Educators can manage, track, and achieve their classroom - learning goals using CircuitVerse platform - -
- -As the CircuitVerse community grows, educators and students can join the online forums to share ideas, questions, and resources related to teaching and learning digital logic design using CircuitVerse. - -![](/img/img_chapter1/1.3.png) - -
- - Figure 1.3: Connect and collaborate on CircuitVerse Forum for sharing ideas, - questions, and resources related to teaching and learning digital logic - design - -
- -Watch the below video for a quick demonstration of the CircuitVerse platform. - -
- -
diff --git a/docs/chapter1/1introduction.mdx b/docs/chapter1/1introduction.mdx new file mode 100644 index 00000000..8579c7db --- /dev/null +++ b/docs/chapter1/1introduction.mdx @@ -0,0 +1,57 @@ +--- +id: chapter1-introduction +title: "Introduction" +description: "Introduction to CircuitVerse and its features." +slug: / +--- + +## What is CircuitVerse? + +Inspired by Logisim, **CircuitVerse** is an open-source educational platform for designing and visualizing digital logic circuits directly in the browser. It enables educators, students, electronics engineers, and hobbyists to experiment with digital circuit simulations and explore various "what-if" scenarios. + +Users can share their creations using unique circuit URLs or fork projects from the CircuitVerse community to satisfy their curiosity. + +![Ripple Carry Adder simulation built using CircuitVerse](/img/img_chapter1/1.1.png) + +*Figure 1.1: Ripple Carry Adder simulation built using CircuitVerse* + +
+ +## Classroom Management + +Developed for educators by educators, CircuitVerse delivers a **high-quality learning experience** at scale. Educators can: + +- Create and manage student groups +- Assign projects with deadlines +- Track submissions and export grades + +Using the CircuitVerse Chrome extension, instructors can embed live circuits into Google Slides or export simulations as images or iFrames. + +![Classroom management interface in CircuitVerse](/img/img_chapter1/1.2.png) + +*Figure 1.2: Classroom management features in CircuitVerse* + +
+ +## Community & Collaboration + +As the CircuitVerse community grows, educators and students can connect through online forums to share ideas, ask questions, and collaborate on digital logic design concepts. + +![CircuitVerse community forum interface](/img/img_chapter1/1.3.png) + +*Figure 1.3: CircuitVerse community forum* + +
+ +## Video Overview + +Watch the video below for a quick demonstration of the CircuitVerse platform: + + + ### Generated Verilog Code @@ -67,10 +97,8 @@ module Main(out1, inp1, inp2); output out1; input inp1, inp2; wire and_0_out; + assign and_0_out = inp1 & inp2; assign out1 = and_0_out; -endmodule -``` - -> TIP: By following these steps, you can efficiently convert your CircuitVerse designs into Verilog code, integrate it into your verilog project and do further simulation and integration into your digital design workflow. The generated verilog code can be also used in reconfigured circuit boards like FPGAs to simulate the hardware. +endmodule \ No newline at end of file diff --git a/package.json b/package.json index 0e01e4d5..0e20bb7f 100644 --- a/package.json +++ b/package.json @@ -45,6 +45,6 @@ ] }, "engines": { - "node": ">=18.0" + "node": ">=18" } } diff --git a/src/css/custom.css b/src/css/custom.css index f290fe31..6d003233 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -5,4 +5,24 @@ height: auto; aspect-ratio: 4 / 3; } +} + +/* === Figure and Caption Styling === */ +figure { + margin: 1.5rem 0; + text-align: center; +} + +figure img { + max-width: 100%; + height: auto; + border-radius: 8px; + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1); +} + +figcaption { + margin-top: 0.5rem; + font-size: 0.9rem; + color: var(--ifm-color-emphasis-600); + font-style: italic; } \ No newline at end of file