updated theme doc on github editme path
This commit is contained in:
@ -18,28 +18,18 @@ There's an Edit me button on each page on this theme. This button allows collabo
|
|||||||
|
|
||||||
Here's the code for that button on the page.html layout:
|
Here's the code for that button on the page.html layout:
|
||||||
|
|
||||||
{% raw %}
|
|
||||||
```
|
|
||||||
{% unless jekyll.environment == "production" %}
|
|
||||||
|
|
||||||
{% if site.github_editme_path %}
|
```
|
||||||
|
{% raw %}{% if site.github_editme_path %}
|
||||||
|
|
||||||
<a target="_blank" href="https://github.com/{{site.github_editme_path}}/{{page.folder}}{{page.url | append: ".md"}}{% endif %}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
|
<a target="_blank" href="https://github.com/{{site.github_editme_path}}/{{page.folder}}{{page.url | append: ".md"}}{% endif %}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
|
||||||
```
|
|
||||||
{% endraw %}
|
|
||||||
|
|
||||||
This code is only active if you're publishing in a development environment, which is the default.
|
{% endraw %}{% endif %}
|
||||||
|
|
||||||
To activate the production environment, add the [production environment flag](http://jekyllrb.com/docs/configuration/) in your build command:
|
|
||||||
|
|
||||||
{% raw %}
|
|
||||||
```
|
```
|
||||||
JEKYLL_ENV=production jekyll serve
|
|
||||||
```
|
|
||||||
{% endraw %}
|
|
||||||
|
|
||||||
In your configuration file, edit the value for `github_editme_path`. For example, you might create a branch called "reviews" on your Github repo. Then you would add something like this in your configuration file for the 'github_editme_path': tomjohnson1492/documentation-theme-jekyll/edit/reviews. Here "tomjohnson1492" is my github account name. The repo name is "documentation-theme-jekyll". The "reviews" name is the branch.
|
In your configuration file, edit the value for `github_editme_path`. For example, you might create a branch called "reviews" on your Github repo. Then you would add something like this in your configuration file for the 'github_editme_path': tomjohnson1492/documentation-theme-jekyll/edit/reviews. Here "tomjohnson1492" is my github account name. The repo name is "documentation-theme-jekyll". The "reviews" name is the branch.
|
||||||
|
|
||||||
|
To suppress this button, comment out the `github_editme_path` in the \_config.yml file.
|
||||||
|
|
||||||
## Add reviewers as collaborators
|
## Add reviewers as collaborators
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user