Skip to content

Commit ed75743

Browse files
authored
Merge pull request #227 from nplatis/local-jekyll
Support running the site locally with Jekyll
2 parents 7f128f4 + 155c9d4 commit ed75743

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,22 @@ in `_data/languages.yml` will need to be extended to include the
8585
language.
8686

8787
See also the [specific guidelines for translators](TRANSLATIONS.md).
88+
89+
## Running the site on your computer
90+
91+
You can run a local copy of the learnlatex.org site on your computer, to test
92+
your contributions before submitting them to GitHub. For this you need:
93+
94+
- [Ruby](https://www.ruby-lang.org/) (version 2.7.0 or higher) and RubyGems
95+
- [Jekyll](https://jekyllrb.com/)
96+
97+
The provided `Gemfile` will take care of building the site and running it locally.
98+
99+
After you have installed the above dependencies, open a terminal, `cd` to the folder of the site's code in your computer, and execute
100+
101+
```bash
102+
bundle exec jekyll serve
103+
```
104+
105+
to build and run the site.
106+
You can add the option `--incremental` at the end to make rebuiling the pages faster.

Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
source "https://rubygems.org"
2+
gem "github-pages", group: :jekyll_plugins

0 commit comments

Comments
 (0)