latex-project.org

Changes to the master branch can be viewed at https://latex3.github.io/, which is the staging environment. If everything looks fine, you can merge master with live to have the server running https://www.latex-project.org/ pick up the changes.

What actually happens is that the _site directory is pulled by the server, so it needs to contain a properly built site (see below).

Branches

The latex-project.org staging
https://latex3.github.io/ - main branch

The latex-project.org website
https://www.latex-project.org/ - live branch

Contributing (team members only)

If you want to develop locally first, this is the way to contribute:

• Fork this repository (and make sure you are in sync with it if you forked a while ago).
• Create a new branch for your changes: git checkout -b branch-name.
• Make your changes.
• Commit locally and push that to your repo.
• Send in a pull request based on the above.

You can also edit/commit directly to the gh-pages branch on github:

• Go to the file/directory you want to edit.
• Make your changes.
• Add a message describing your edit.
• Commit directly to the gh-pages branch / Create a new branch for this commit and start a pull request.

Requirements

In order to contribute to the website’s codebase, you’ll need to know a bit about Git, Jekyll, CSS or Sass, Markdown, and some Command Line-fu. You'll also need to know how to install Ruby Gems and of course have Ruby installed on your machine.

Local Development

Gem Installation

Use the bundle command to install the necessary gems for the LaTeX Project. If you don't have bundler installed you'll need to run gem install bundler before using bundle.

$ bundle install

Preview

Trigger the local server by executing the jekyll serve task.

$ jekyll serve

Your local copy will now be accessible at http://localhost:4000. Then use CTRL + C to stop the server.

Generate the site version

jekyll serve saves the site in _sitebut it changes the site url to localhost (as of version 4.x) so it is no longer possible to use that directory as the official site. Instead you now need to run

$ jekyll build

to get the {{ site.url }} variable set correctly.

Resources

• Git Documentation
• Jekyll Documentation
• CSS Documentation
• SASS Documentation
• Markdown Documentation
• Kramdown Documentation

Website

Webdesign License

The latex-project.org webdesign by Jonas Jacek is licensed under a Creative Commons Attribution 4.0 International License. Based on a work at https://github.com/latex3/latex3.github.io.

This is a Free Culture License!

However, the license requires you to give appropriate credit to Jonas, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests Jonas or the LaTeX Project endorses you or your use.

Please credit Jonas with a link to his website (http://jonas.me/) and state the license somewhere on your page. Everything else brings bad karma.

Reporting Website Bugs

If you think you've found a bug on our website you can report it to the website team at mailto:[email protected]. If you do submit a report, thanks for taking the time!