learnmonkey.github.io/contributing.html at main · learnmonkey/learnmonkey.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
---
title: Contributing
permalink: /contributing/
layout: default
---


<h1>Contributing</h1>

<p>If you want to add some content or fix something, fork this repository and make your edits. Then, you can create a pull request.</p>
<p>If you want to make some suggestions, you can open an issue. For more information, take a look at <a href="CONTRIBUTING.md">CONTRIBUTING.md</a>.</p>
<p>You can also view the <a href="https://github.com/learnmonkey/learnmonkey.github.io/wiki/Todo-List">Todo List</a> in the Wiki.</p>
<h1 id="running-learnmonkey">Running Learnmonkey</h1>
<p>In order to run an instance of Learnmonkey, you need:</p>
<ul>
    <li>Ruby</li>
    <li>RubyGems</li>
    <li>Jekyll</li>
</ul>
<p>Now, you can run Learnmonkey: </p>
<pre><code class="language-batch">bundle exec jekyll serve</code></pre>

<p>Just forking the GitHub repository on GitHub will also allow you to view the site if you connect the <code>main</code> branch to GitHub pages and run the site. However, do note that this method will mess up the permalinks so you will need to type the links in your address bar manually.</p>