Giter Site home page Giter Site logo

latex-roam's Introduction

Roam to LaTeX exporter

GitHub package.json version codecov File size in bytes for extension.js GitHub Maintenance

This plugin is written to enable easy, clean exports from Roam to LaTeX. It aims to fully support all of Roam's markup, while augmenting it with special syntax and capabilities such as:

  • referencing tables, figures, and equations in-text
  • extracting citekeys, following the pattern [[@citekey]]
  • (optional) generating a bibliography, if zoteroRoam is also installed

Getting Started

When the extension is active, you can:

  • export a full page, by navigating to that page and clicking the "LaTeX" button that appears under the title
  • export a specific block (with all its descendants), by opening the block's menu > Plugins > Export to LaTeX

Both will open an export dialog, where you will be able to configure settings and generate files.

Questions & Issues

To learn more about how the plugin parses Roam content into LaTeX, browse the wiki documentation.

If you run into any issues, or have feedback to help improve the plugin, create an issue on GitHub, post in the LaTeX channel of the Academia Roamana Discord, or reach out directly on Twitter @AlixLahuec.

Overleaf integration

The plugin offers a one-click export to Overleaf, a free online collaborative LaTeX editor. Note that any figures or bibliography files will then have to be uploaded to Overleaf separately, as this currently cannot be done automatically via the API.

zoteroRoam integration

If the plugin detects a compatible version of zoteroRoam in your Roam graph, it will connect to it and generate a .bib file if any citekeys are present in the page or block you're exporting.

latex-roam's People

Contributors

alixlahuec avatar github-actions[bot] avatar

Stargazers

Lennart Klein avatar  avatar QIU QIYUAN avatar Qiwei Zhao avatar Tomas Fiers avatar

Watchers

 avatar

latex-roam's Issues

Images from Dropbox cause error

If there is an image link on the page like so:
![](https://www.dropbox.com/s/iu0dvjsuaipftdz/image%20%2831%29.png?raw=1)
this will cause a Type Error:
image

Those type of image links are generated from the Roam Dropbox Extension.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.