You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To view the docs in offline mode, navigate to `/docs` folder and run
22
-
`python3 -m http.server` (for python3.x) or
23
-
`python -m SimpleHTTPServer 8000` (for python2.x) or
24
-
`python -m http.server`
21
+
### Prerequisites
22
+
- Node.js (version 18 or higher recommended)
23
+
- npm or yarn package manager
25
24
25
+
### Installation
26
26
27
-
When you add a page, make sure you have an entry in the `_sidebar.md`
27
+
Install the dependencies:
28
+
29
+
```sh
30
+
npm install
31
+
```
32
+
33
+
### Running Locally
34
+
35
+
Start the development server:
36
+
37
+
```sh
38
+
npm start
39
+
```
40
+
41
+
This will start a local development server and open the documentation in your default browser at `http://localhost:3000`. The site will automatically reload when you make changes.
42
+
43
+
### Building for Production
44
+
45
+
To build the static files for production:
46
+
47
+
```sh
48
+
npm run build
49
+
```
50
+
51
+
The production-ready files will be generated in the `build` directory.
52
+
53
+
When you add a new page, make sure you have an entry in the `sidebars.js` file.
28
54
29
55
> [!NOTE]
30
56
> **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.**
@@ -34,7 +60,10 @@ When you add a page, make sure you have an entry in the `_sidebar.md`
34
60
2. Click `New site from Git` or go to [https://app.netlify.com/start](https://app.netlify.com/start)
35
61
3. Click `GitHub` and authorise Netlify to view all your repositories or just the repository that you would like to publish
36
62
* You will need to be the owner of the repository as Netlify needs to add a webhook and deploy key. You can get around this by forking the repository and publishing that instead
37
-
4. Click `Deploy site` (you do not need to change any settings other than maybe `branch`)
0 commit comments