Skip to content

Commit ba4b184

Browse files
Merge branch 'main' into author-roles
2 parents ee78adb + a9db0a7 commit ba4b184

437 files changed

Lines changed: 30379 additions & 1683 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitattributes

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +0,0 @@
1-
*.jpg filter=lfs diff=lfs merge=lfs -text
2-
*.jpeg filter=lfs diff=lfs merge=lfs -text
3-
*.webp filter=lfs diff=lfs merge=lfs -text
4-
*.ico filter=lfs diff=lfs merge=lfs -text
5-
*.png filter=lfs diff=lfs merge=lfs -text
6-
*.gif filter=lfs diff=lfs merge=lfs -text

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,5 @@ vendor
2323
.sass-cache
2424
_site
2525
package.json
26+
.ruby-version
27+
Gemfile.lock

AUTHORS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following people have made contributions to learnlatex.org:
1010

1111
| Name | Role |
1212
|--- |---|
13-
| Takuto Asakura | _Japanese translation _ |
13+
| Takuto Asakura | _Japanese translation_ |
1414
| Barbara Beeton | _Initial content discussions_ |
1515
| Denis Bitouzé | _Improvements to lists description_ |
1616
| David Carlisle | _Initial content discussions, editor and server integration_ |
@@ -30,7 +30,7 @@ The following people have made contributions to learnlatex.org:
3030
| Jonathan P. Spratte | _Initial content discussions, tables lesson, German translation_ |
3131
| Fernando S. Delgado Trujillo | _Spanish translation_ |
3232
| Vivek Tripathi | _Hindi translation_ |
33-
| Moritz Wemheuer | _Bibtex and Biblatex documentation _ |
33+
| Moritz Wemheuer | _Bibtex and Biblatex documentation_ |
3434
| Joseph Wright | _Initial concept, Project lead_ |
3535
| Dung Vu | _Vietnamese translation_ |
3636
| Daniel Zhang | _Chinese translations_ (×2) |

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

TRANSLATIONS.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,21 @@ the top level of the repository as your fork will not be running at learnlatex.o
2626

2727
## Adding your language
2828

29-
Once the initial site is working, you can make add the new language
29+
Once the initial site is working, you can add the new language
3030
files by taking the ISO 639-1 two letter language code for your
3131
language, which we shall assume is `zz`. It may be necessary to use a
3232
two part name denoting the script, for example `zh-Hans` or `zh-Hant`
3333
(Simplified and Traditional Chinese) as specified in RFC 4646. We hope
34-
to avoid regional variants. For example the `en` ages mostly follow US
34+
to avoid regional variants. For example the `en` pages mostly follow US
3535
usage of English but we do not envisage separate `en-US` and `en-gb`
3636
pages.
3737

3838

39-
1. Make a new directory `zz` as a copy of the english pages in `en`, including the subdirectory `en/includes`
40-
2. Add the two letter code `zz` to the `langs:` array in the `_config.yml` file.
41-
3. Change all instances of `en/` in `zz/index.md` to `zz/`
42-
4. Translate the fixed strings in `zz/includes/buttons.js` into your language.
39+
1. Make a new directory `zz` as a copy of the English pages in `en`, including the subdirectory `en/includes`
40+
2. Change all instances of `en/` in `zz/index.md` to `zz/`
41+
3. Translate the fixed strings in `zz/includes/buttons.js` into your language.
4342
This is for the buttons used in examples such as "Open in Overleaf".
44-
5. Add a new enty in `_data/languages.yml` This should specify the
43+
4. Add a new entry in `_data/languages.yml`. This should specify the
4544
code, the name of your language in the language and in English, for example
4645
the French entry is
4746

@@ -50,7 +49,7 @@ pages.
5049
label-regional: Français
5150
label-english: French
5251
```
53-
6. Update each section of `_data/translations.yml` with the an entry for
52+
5. Update each section of `_data/translations.yml` with an entry for
5453
each of the fixed strings in the site. So for example the entry for "Next Lesson"
5554
should be amended to have a `zz:` entry:
5655

@@ -66,7 +65,7 @@ pages.
6665
vi: "Bài tiếp theo"
6766
zz: "YOUR TRANSLATION HERE"
6867
```
69-
68+
7069
Note that if you want your translation to use localised digits for lesson numbers
7170
you may optionally add an entry to the `navigational-elements_digits` array
7271
with a string consisting of a comma separated list of numbers 0--20.
@@ -108,7 +107,7 @@ The variable names should not be changed but the values should be changed to you
108107
## Lesson text.
109108

110109
We ask that translations are fairly literal translations of the
111-
english text. The intention is that the structure of the course and
110+
English text. The intention is that the structure of the course and
112111
order and depth that subjects are introduced are the same for all the
113112
languages hosted on the site.
114113

_config.yml

Lines changed: 0 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -32,69 +32,3 @@ compress_html:
3232
profile: false
3333
startings: [html, head, body]
3434

35-
36-
# LANGUAGES, LABELS, LAYOUTS
37-
# Settings for multilingual set up:
38-
# In alphabetical order by language code.
39-
# In ascending order by path specifity.
40-
# https://jekyllrb.com/docs/configuration/front-matter-defaults/
41-
defaults:
42-
-
43-
scope:
44-
path: ""
45-
values:
46-
lang: "en"
47-
-
48-
scope:
49-
path: "de"
50-
values:
51-
lang: "de"
52-
label: "Deutsch"
53-
-
54-
scope:
55-
path: "en"
56-
values:
57-
lang: "en"
58-
label: "English"
59-
-
60-
scope:
61-
path: "es"
62-
values:
63-
lang: "es"
64-
label: "Español"
65-
-
66-
scope:
67-
path: "fr"
68-
values:
69-
lang: "fr"
70-
label: "Français"
71-
-
72-
scope:
73-
path: "pt"
74-
values:
75-
lang: "pt"
76-
label: "Português"
77-
-
78-
scope:
79-
path: "vi"
80-
values:
81-
lang: "vi"
82-
label: "Tiếng Việt"
83-
-
84-
scope:
85-
path: "tr"
86-
values:
87-
lang: "tr"
88-
label: "Türkçe"
89-
-
90-
scope:
91-
path: "mr"
92-
values:
93-
lang: "mr"
94-
label: "मराठी"
95-
-
96-
scope:
97-
path: "ca"
98-
values:
99-
lang: "ca"
100-
label: "Català"

_data/languages.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,22 @@
2323
label-regional: Français
2424
label-english: French
2525

26+
- language-code: hi
27+
label-regional: हिंदी
28+
label-english: Hindi
29+
30+
- language-code: it
31+
label-regional: Italiano
32+
label-english: Italian
33+
34+
- language-code: ja
35+
label-regional: 日本語
36+
label-english: Japanese
37+
38+
- language-code: lt
39+
label-regional: Lietuviškai
40+
label-english: Lithuanian
41+
2642
- language-code: mr
2743
label-regional: मराठी
2844
label-english: Marathi
@@ -35,8 +51,17 @@
3551
label-regional: Tiếng Việt
3652
label-english: Vietnamese
3753

54+
- language-code: zh-hans
55+
label-regional: 中文(简体)
56+
label-english: Simplified Chinese
57+
58+
- language-code: zh-hant
59+
label-regional: 中文(繁體)
60+
label-english: Traditional Chinese
61+
3862
# - language-code: tr
3963
# label-regional: Türkçe
4064
# label-english: Turkish
4165

4266

67+

0 commit comments

Comments
 (0)