Skip to content

Commit da22b39

Browse files
authored
feat: added instructions on how to setup Docusaurus to README.md (#44)
1 parent c36a8c0 commit da22b39

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,68 @@ This document provides pointers for those looking to make documentation changes
88

99
- [Documentation Overview](https://github.com/magma/magma/wiki/Contributing-Documentation) for general documentation information
1010
- `make help` for specific commands
11+
12+
## What is Docusaurus?
13+
14+
[Docusaurus](https://docusaurus.io/) is an open-source static site generator built by Meta and powered using React. It’s optimized for creating technical documentation websites for open-source projects, with support for document versioning, ready for translations, content search, and a hot reload feature.
15+
16+
---
17+
18+
## Repository Structure
19+
20+
```text
21+
docusaurus/
22+
├── Dockerfile
23+
├── docker-compose.yml
24+
├── docs/
25+
├── docusaurus.config.js
26+
├── sidebars.js
27+
├── static/
28+
├── src/
29+
readmes/
30+
```
31+
32+
---
33+
34+
## How to Setup Docusaurus
35+
36+
1. **Install Docker**
37+
Download and install [Docker Engine](https://docs.docker.com/engine/install/)
38+
39+
For Windows, you must instead install [Docker Desktop](https://apps.microsoft.com/detail/XP8CBJ40XLBWKX?hl=pt-BR&gl=BR&ocid=pdpshare)
40+
41+
3. **Clone the Repository**
42+
Open a terminal in any directory and run:
43+
```bash
44+
git clone https://github.com/magma/magma-documentation.git
45+
```
46+
47+
4. **Start Docusaurus with Docker**
48+
Navigate to the project folder:
49+
```bash
50+
cd magma-documentation/docusaurus
51+
```
52+
and set up Docusaurus by:
53+
```bash
54+
docker compose up dev
55+
```
56+
57+
5. **Access the Documentation**
58+
Once running, open your browser and visit: [http://localhost:3000/](http://localhost:3000/)
59+
60+
6. **Proper Shutdown**
61+
You can stop this proccess without losing persistent data or associated configurations through:
62+
```bash
63+
docker-compose stop
64+
```
65+
Or completely clean up your Docker environment with:
66+
```bash
67+
docker-compose down
68+
```
69+
---
70+
71+
## Contact
72+
73+
For further assistance, join our [Slack channel](https://magmacore.slack.com/archives/C01PGTJECGJ)!
74+
75+

0 commit comments

Comments
 (0)