-
Notifications
You must be signed in to change notification settings - Fork 8
feat: added instructions on how to setup Docusaurus to README.md #43
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,3 +8,62 @@ 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 | ||
``` | ||
Comment on lines
+47
to
+50
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Docker already starts by default. Even if not, we assume it does. You can remove this. |
||
Navigate to the project folder: | ||
```bash | ||
cd magma-documentation/docusaurus | ||
``` | ||
and set up Docusaurus by: | ||
```bash | ||
docker compose up dev | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
``` | ||
|
||
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)! | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add the readmes directory - there is where new documentation is made