Skip to content

Commit b8b043f

Browse files
tachyonssalmoneatenbybear
tachyons
and
salmoneatenbybear
authored
Move from docsify to docusaurus #383 (#405)
--------- Co-authored-by: salmoneatenbybear <salmoneatenbybear@gmail.com>
1 parent 2daf49f commit b8b043f

219 files changed

Lines changed: 20913 additions & 2562 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
112
.DS_Store
2-
.idea/
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎config.json‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{
2+
"appId": "DM4KWCC17E",
3+
"apiKey": "8d998bfb5e12b330595f6e4c8a6368d8",
4+
"rateLimit": 8,
5+
"maxDepth": 10,
6+
"startUrls": ["https://circuitverse-docs.netlify.app/"],
7+
"sitemaps": ["https://circuitverse-docs.netlify.app/sitemap.xml"],
8+
"ignoreCanonicalTo": true,
9+
"discoveryPatterns": ["https://circuitverse-docs.netlify.app/**"],
10+
"actions": [
11+
{
12+
"indexName": "circuitverse-netlify",
13+
"pathsToMatch": ["https://circuitverse-docs.netlify.app/**"],
14+
"recordExtractor": {
15+
"type": "function",
16+
"function": "({ $, helpers }) => { const lvl0 = $('.menu__link.menu__link--sublist.menu__link--active, .navbar__item.navbar__link--active').last().text() || 'Documentation'; return helpers.docsearch({ recordProps: { lvl0: { selectors: '', defaultValue: lvl0 }, lvl1: ['header h1', 'article h1'], lvl2: 'article h2', lvl3: 'article h3', lvl4: 'article h4', lvl5: 'article h5, article td:first-child', lvl6: 'article h6', content: 'article p, article li, article td:last-child' }, indexHeadings: true, aggregateContent: true, recordVersion: 'v3' }); }"
17+
}
18+
}
19+
],
20+
"initialIndexSettings": {
21+
"circuitverse-docs": {
22+
"attributesForFaceting": ["type", "lang", "language", "version", "docusaurus_tag"],
23+
"attributesToRetrieve": ["hierarchy", "content", "anchor", "url", "url_without_anchor", "type"],
24+
"attributesToHighlight": ["hierarchy", "content"],
25+
"attributesToSnippet": ["content:10"],
26+
"camelCaseAttributes": ["hierarchy", "content"],
27+
"searchableAttributes": [
28+
"unordered(hierarchy.lvl0)",
29+
"unordered(hierarchy.lvl1)",
30+
"unordered(hierarchy.lvl2)",
31+
"unordered(hierarchy.lvl3)",
32+
"unordered(hierarchy.lvl4)",
33+
"unordered(hierarchy.lvl5)",
34+
"unordered(hierarchy.lvl6)",
35+
"content"
36+
],
37+
"distinct": true,
38+
"attributeForDistinct": "url",
39+
"customRanking": ["desc(weight.pageRank)", "desc(weight.level)", "asc(weight.position)"],
40+
"ranking": ["words", "filters", "typo", "attribute", "proximity", "exact", "custom"],
41+
"highlightPreTag": "<span class=\"algolia-docsearch-suggestion--highlight\">",
42+
"highlightPostTag": "</span>",
43+
"minWordSizefor1Typo": 3,
44+
"minWordSizefor2Typos": 7,
45+
"allowTyposOnNumericTokens": false,
46+
"minProximity": 1,
47+
"ignorePlurals": true,
48+
"advancedSyntax": true,
49+
"attributeCriteriaComputedByMinProximity": true,
50+
"removeWordsIfNoResults": "allOptional",
51+
"separatorsToIndex": "_"
52+
}
53+
}
54+
}

‎docs/README.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs/_sidebar.md‎

Lines changed: 0 additions & 41 deletions
This file was deleted.

‎docs/chapter1/1introduction.md‎

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,67 @@
1+
---
2+
id: chapter1-introduction
3+
title: "Introduction"
4+
description: "Introduction page in Chapter1 of CircuitVerse documentation."
5+
slug : /
6+
---
7+
18
# Introduction
29

3-
<iframe width="100%" height="330px" src="https://circuitverse.org/simulator/embed/701" id="projectPreview" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
10+
<iframe
11+
width="100%"
12+
height="330px"
13+
src="https://circuitverse.org/simulator/embed/701"
14+
id="projectPreview"
15+
scrolling="no"
16+
webkitAllowFullScreen
17+
mozAllowFullScreen
18+
allowFullScreen
19+
>
20+
{" "}
21+
</iframe>
422

523
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.
624

7-
![](../images/img_chapter1/1.1.png)
25+
![](/img/img_chapter1/1.1.png)
826

9-
<div align="center"><em>Figure 1.1: Ripple Carry Adder simulation built using CircuitVerse</em></div>
27+
<div align="center">
28+
<em>Figure 1.1: Ripple Carry Adder simulation built using CircuitVerse</em>
29+
</div>
1030

11-
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.
31+
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.
1232

13-
![](../images/img_chapter1/1.2.png)
33+
![](/img/img_chapter1/1.2.png)
1434

15-
<div align="center"><em>Figure 1.2: Educators can manage, track, and achieve their classroom learning goals using CircuitVerse platform</em></div>
35+
<div align="center">
36+
<em>
37+
Figure 1.2: Educators can manage, track, and achieve their classroom
38+
learning goals using CircuitVerse platform
39+
</em>
40+
</div>
1641

1742
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.
1843

19-
![](../images/img_chapter1/1.3.png)
44+
![](/img/img_chapter1/1.3.png)
2045

21-
<div align="center"><em>Figure 1.3: Connect and collaborate on CircuitVerse Forum for sharing ideas, questions, and resources related to teaching and learning digital logic design</em></div>
46+
<div align="center">
47+
<em>
48+
Figure 1.3: Connect and collaborate on CircuitVerse Forum for sharing ideas,
49+
questions, and resources related to teaching and learning digital logic
50+
design
51+
</em>
52+
</div>
2253

2354
Watch the below video for a quick demonstration of the CircuitVerse platform.
2455

2556
<div>
26-
<iframe width="500px" height="400px" src="https://www.youtube.com/embed/3Df-2Cn_80A" frameborder="0" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen></iframe>
27-
</div>
57+
<iframe
58+
width="500px"
59+
height="400px"
60+
src="https://www.youtube.com/embed/3Df-2Cn_80A"
61+
frameborder="0"
62+
scrolling="no"
63+
webkitAllowFullScreen
64+
mozAllowFullScreen
65+
allowFullScreen
66+
></iframe>
67+
</div>

‎docs/chapter1/2keyfeatures.md‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,33 @@
1+
---
2+
id: chapter1-keyfeatures
3+
title: "Keyfeatures"
4+
description: "Keyfeatures page in Chapter1 of CircuitVerse documentation."
5+
---
6+
17
# Key Features
28

39
This section shares key features of the CircuitVerse simulator.
410

5-
![](../images/img_chapter1/1.4.png)
11+
![](/img/img_chapter1/1.4.png)
612

7-
<div align="center"><em>Figure 1.4: Some of the key features of the CircuitVerse simulator</em></div>
13+
<div align="center">
14+
<em>Figure 1.4: Some of the key features of the CircuitVerse simulator</em>
15+
</div>
816

9-
1. **Build and simulate your circuits in the cloud**: Create and run your simulations in your browser without the hassle of software installation or operating system dependent instructions. Since the process of circuit creation and simulation is seamless, users can edit and troubleshoot their circuit design or apply changes while the simulation is running. Users can save and open their circuits online (against the user’s dashboard) or offline (locally on their machine).
17+
1. **Build and simulate your circuits in the cloud**: Create and run your simulations in your browser without the hassle of software installation or operating system dependent instructions. Since the process of circuit creation and simulation is seamless, users can edit and troubleshoot their circuit design or apply changes while the simulation is running. Users can save and open their circuits online (against the user’s dashboard) or offline (locally on their machine).
1018

11-
2. **Transform your ideas using a powerful, intuitive and interactive schematic editor**:
19+
2. **Transform your ideas using a powerful, intuitive and interactive schematic editor**:
1220

13-
- **Design using an easy-to-use interactive schematic editor**: As users drag and drop circuit elements on the canvas, horizontal and vertical wires can be drawn to complete the circuit connections. The wires are color coded to test and analyze the circuit simulations with ease.
14-
- **Customize input attributes of circuit components**: CircuitVerse includes a vast library of circuit elements that range from basic gates to register transfer level design, and from basic input/output to system level components. Most of the CircuitVerse components include customizable attributes for building complex designs within the simulator.
15-
- **Design supports multibit wires (buses)**: Every input and output circuit element has a bit width associated with it. Most of the CircuitVerse components include attributes allowing you to customize the bit widths of their inputs and outputs. CircuitVerse supports multibit wires across two components demanding multi bit widths. As needed, splitters can also be used to direct bits in different directions.
21+
- **Design using an easy-to-use interactive schematic editor**: As users drag and drop circuit elements on the canvas, horizontal and vertical wires can be drawn to complete the circuit connections. The wires are color coded to test and analyze the circuit simulations with ease.
22+
- **Customize input attributes of circuit components**: CircuitVerse includes a vast library of circuit elements that range from basic gates to register transfer level design, and from basic input/output to system level components. Most of the CircuitVerse components include customizable attributes for building complex designs within the simulator.
23+
- **Design supports multibit wires (buses)**: Every input and output circuit element has a bit width associated with it. Most of the CircuitVerse components include attributes allowing you to customize the bit widths of their inputs and outputs. CircuitVerse supports multibit wires across two components demanding multi bit widths. As needed, splitters can also be used to direct bits in different directions.
1624

17-
3. **Insert subcircuit**: Hierarchical circuits can be created by nesting and reusing smaller circuits in larger circuits (something like this). No need to mention verilog here.
25+
3. **Insert subcircuit**: Hierarchical circuits can be created by nesting and reusing smaller circuits in larger circuits (something like this). No need to mention verilog here.
1826

1927
4. **Export images in multiple formats**: High-resolution CircuitVerse images can be exported in multiple formats for different views and background options.
2028

2129
5. **Visualize circuit simulations using timing diagram**: Timing diagrams can be used to analyze and debug the behavior of circuits for different input sequences. debug logical mistakes and race conditions. Timing diagrams can be paired with the Flag circuit element to explain different concepts such as propagation delay, stable state and race conditions.
2230

23-
6. **Embed simulations across webpages and presentations**: Since the CircuitVerse webpages are structured using HTML5, an iframe can be generated for embedding each CircuitVerse simulation within web pages. Alternatively, users can download the CircuitVerse Chrome extension for embedding live CircuitVerse circuits within a Google Slides presentation.
24-
25-
7. **Connect and collaborate over CircuitVerse**: Users can also share their unique circuit URLs and seek help from the CircuitVerse online forums. If needed, they can also collaborate over their creations or fork an existing user contribution for meaningful learning.
31+
6. **Embed simulations across webpages and presentations**: Since the CircuitVerse webpages are structured using HTML5, an iframe can be generated for embedding each CircuitVerse simulation within web pages. Alternatively, users can download the CircuitVerse Chrome extension for embedding live CircuitVerse circuits within a Google Slides presentation.
2632

33+
7. **Connect and collaborate over CircuitVerse**: Users can also share their unique circuit URLs and seek help from the CircuitVerse online forums. If needed, they can also collaborate over their creations or fork an existing user contribution for meaningful learning.

‎docs/chapter1/3systemrequirments.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1+
---
2+
id: chapter1-systemrequirments
3+
title: "Systemrequirments"
4+
description: "Systemrequirments page in Chapter1 of CircuitVerse documentation."
5+
---
6+
17
# System Requirements
28

39
In order to access CircuitVerse simulations on a Mac or a PC, you will need a broadband internet connection and a compatible web browser. CircuitVerse officially supports Google Chrome and Mozilla Firefox. While users have been able to successfully run the simulator on Apple Safari, we are unable to officially support this browser at this time.
410

5-
>NOTE: Since CircuitVerse is built in HTML5, browsers do not require Flash Player or JavaScript to load the CircuitVerse simulator.
11+
> NOTE: Since CircuitVerse is built in HTML5, browsers do not require Flash Player or JavaScript to load the CircuitVerse simulator.
612
713
Additionally, CircuitVerse does not support touch screen devices or mobile browsers for any device.

0 commit comments

Comments
 (0)