Skip to content

Revert "feat(Update README.md)" #2

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Revert "feat(Update README.md)" #2

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
59 changes: 0 additions & 59 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,62 +8,3 @@ This document provides pointers for those looking to make documentation changes

- [Documentation Overview](https://github.com/magma/magma/wiki/Contributing-Documentation) for general documentation information
- `make help` for specific commands

## What is Docusaurus?

[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.

---

## Repository Structure

```text
docusaurus/
├── Dockerfile
├── docker-compose.yml
├── docs/
├── docusaurus.config.js
├── sidebars.js
├── static/
└── src/
```

---

## How to Setup Docusaurus

1. **Install Docker**
Download and install [Docker Engine](https://docs.docker.com/engine/install/)

For Windows, you must instead install [Docker Desktop](https://apps.microsoft.com/detail/XP8CBJ40XLBWKX?hl=pt-BR&gl=BR&ocid=pdpshare)

3. **Clone the Repository**
Open a terminal in any directory and run:
```bash
git clone https://github.com/magma/magma-documentation.git
```

4. **Start Docusaurus with Docker**
You can now start Docker by opening it if you chose to install Docker Desktop or, for Docker Engine, with:
```bash
sudo systemctl start docker
```
Navigate to the project folder:
```bash
cd magma-documentation/docusaurus
```
and set up Docusaurus by:
```bash
docker compose up dev
```

5. **Access the Documentation**
Once running, open your browser and visit: [http://localhost:3000/](http://localhost:3000/)

---

## Contact

For further assistance, join our [Slack channel](https://magmacore.slack.com/archives/C01PGTJECGJ)!