Skip to content

Commit

Permalink
Added contributing to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hrushikeshrv committed Jan 28, 2024
1 parent a9e100c commit 78c04f5
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ editors like Microsoft Word or Google Docs.
- Convert created equations into LaTeX.

# Contributing
Please read [CONTRIBUTING.md](https://github.com/hrushikeshrv/mjxgui/blob/main/CONTRIBUTING.md) to get started.
Please read [CONTRIBUTING.md](docs/contributing.md) to get started.

# Installation
MJXGUI uses MathJax as a core dependency, so you need to include both MathJax and
Expand Down
8 changes: 8 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,12 @@ callouts:

ga_tracking: G-TGM5F6WJNV

nav_external_links:
- title: View on GitHub
url: https://github.com/hrushikeshrv/mjxgui
opens_in_new_tab: true
- title: Raise an Issue
url: https://github.com/hrushikeshrv/mjxgui/issues
opens_in_new_tab: true

favicon_ico: "/media/favicon.png"
6 changes: 6 additions & 0 deletions CONTRIBUTING.md → docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
layout: default
title: Contributing
nav_order: 6
---

# Contributing to MJXGUI

Thanks for volunteering your time and effort toward the development of MJXGUI! To make the contribution process as smooth as possible, follow the steps below to set up your development environment.
Expand Down

0 comments on commit 78c04f5

Please sign in to comment.