Skip to content
Snippets Groups Projects
Normal view Permalink
Readme.md 2.28 KiB
Newer Older
  • Learn to ignore specific revisions
    • Johannes Keyser's avatar
    copied everything from multilingual example
    Johannes Keyser committed
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 
    # Multilingual Jekyll

This repository aims to show how to get a minimal multilingual *Jekyll* website.

It is based on the [**Making *Jekyll* multilingual**](https://www.sylvaindurand.org/making-jekyll-multilingual/) article, applied on the [Jekyll default theme](https://github.com/jglovier/jekyll-new).

You can check the demo on [sylvaindurand.github.io/jekyll-multilingual/](https://sylvaindurand.github.io/jekyll-multilingual/).

**Warning**: this repo is not maintained anymore by its author, but pull requests are still welcomed.


## Make your website multilingual

1. Have a look at the article [Making *Jekyll* multilingual](https://www.sylvaindurand.org/making-jekyll-multilingual/), which explains how things work
2. Check the [diff for Jekyll 3.1.x](https://github.com/sylvaindurand/jekyll-multilingual/commit/111495e91e8986db21368e54a42188cdbbc44b6f) (older versions: [3.0.x](https://github.com/sylvaindurand/jekyll-multilingual/commit/b2da2a07c325a1b6e01f524dad6582f2daf70ccf), [2.5.x](https://github.com/sylvaindurand/jekyll-multilingual/commit/e0bed79df22d2d35a75d0906e2c9c2baeac44a73))
3. Reproduce it on your website!


## Create a multilingual website from stratch

1. Still have a look at the article [Making *Jekyll* multilingual](https://www.sylvaindurand.org/making-jekyll-multilingual/), which explains how things work!
2. Clone the repo: `git clone https://github.com/sylvaindurand/jekyll-multilingual.git`
3. Open the folder: `cd jekyll-multilingual`
4. Remove `Readme.md` and `jekyll-multilingual.gemspec`, which are useless outside this repository
5. Build the website: `jekyll build`

## Colophon

After having written an article about having a multilingual *Jekyll* website, [sigul](https://talk.jekyllrb.com/t/a-vanilla-jekyll-theme-multilingual-with-no-plugins/) gave the idea to provide a minimal working example. Here we are!

The [source code](https://github.com/sylvaindurand/jekyll-multilingual) is freely available on [GitHub](https://github.com/sylvaindurand/jekyll-multilingual). The *Jekyll* default theme is released under the MIT License, such as the modifications shown in this repository.

## Question?
Please feel free to [open an issue](https://github.com/sylvaindurand/jekyll-multilingual/issues) or to [push a commit](https://github.com/sylvaindurand/jekyll-multilingual/pulls).