The Open in LetX badge
Put it on the README of a paper, a thesis, a CV template or course notes. One click opens the repository as a project in LetX, so a reader can compile it and try changes in the browser, with no TeX installation.
Get the badge for your repository
A repository, or a folder in one: github.com/owner/repo/tree/main/paper.
[](https://letx.app/open?repo=your-name/your-paper)<a href="https://letx.app/open?repo=your-name/your-paper"><img src="https://letx.app/badges/open-in-letx.svg" alt="Open in LetX"></a>What happens when someone clicks it
- They see the repository’s name and a button. Nothing is created until they press it.
- Their browser reads the public files from GitHub and creates a project in their own LetX account.
- The editor opens on the document that builds, worked out from the files, and they can compile at once.
The project is a copy. To keep a project and a repository in step, private repositories included, connect GitHub in LetX, part of Pro. Moving a whole library of projects instead? See how to import every project at once.
Badges for gallery templates
Every template in the LetX template gallery has a badge of its own, with the Markdown and HTML on the template’s page. Put it on a thesis guide, a course page or a lab wiki, and a student who clicks it gets their own copy of the template as a new project, ready to compile. Someone signed out signs up or logs in first, and comes straight back to the template.
The link names the template by the last part of its page’s address: https://letx.app/open?template=template-name
Frequently asked questions
What does the Open in LetX badge do?
It opens a public GitHub repository as a new LetX project. Whoever clicks it gets their own copy of the files in the online LaTeX editor, ready to compile, with nothing to install.
Do readers need an account?
Yes, a free LetX account. Someone signed out is asked to sign up or log in, and then comes straight back to the repository they clicked.
Can the badge open one folder of a repository?
Yes. Link to the folder as GitHub shows it, for example github.com/owner/repo/tree/main/paper, or add &path=paper to the badge link. Add &ref= to open a branch or a tag.
Does it keep the copy in sync with GitHub?
No. The badge makes a copy, and changes made in LetX stay in LetX. To pull from and push to a repository, private ones included, connect GitHub in LetX, which is part of Pro.
Does LetX store or change my repository?
No. The reader’s browser reads the public files from GitHub and creates a project in their own account. Nothing is written to your repository, and nothing is created until the reader clicks the button.