Skip to content

Added some documentation #3

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 4 commits into
base: main
Choose a base branch
from
Open

Added some documentation #3

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6831eac
Found errors
Sep 2, 2025
7baac97
Add more documentation for running locally or running on a deployment…
Sep 15, 2025
2e1a5c4
Remove unnecessary debugs
Sep 15, 2025
5c81a05
Merge branch 'develmusa:main' into main
nicolasshu Sep 15, 2025
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,14 @@ plugins:
- graph
```

As part of the package, the plugin looks for the key `site_url` in order to create the appropriate URLs to link and create the graphs. If you are experiencing an empty graph, enter a URL along with the protocol to your `mkdocs.yml` file. E.g.:

```yaml
site_url: "https://example.com/username/repository"
```

If you are using `mkdocs serve` to preview your website, you may wish to pass an address argument. E.g., `mkdocs serve -a localhost:8000`

### 3. Build your docs

```bash
Expand Down