Giter VIP home page Giter VIP logo

atom-latex's Introduction

LaTeX package Build Status

Compile LaTeX documents from within Atom.

Installing

Use the Atom package manager and search for "latex", or run apm install latex from the command line.

Prerequisites

TeX distribution

Since this package relies upon either latexmk or texify, a reasonably up to date and working TeX distribution is required. The only current officially supported distributions are TeX Live, and MiKTeX. Although the latter is not as well tested and supported as TeX Live, hence using TeX Live is highly recommended.

You need to ensure that the package can find your TeX distribution; if you're using TeX Live and have installed to the default location then no further action should be required. To help the package find the distribution's binaries, you need to configure the TeX Path configuration variable to point to the folder containing the binaries. This can be done either in the settings view, or directly in your config.cson file.

Usage

Invoke the build command by pressing the default keybind ctrl-alt-b while in a .tex file.

Magic comments

The package has support for the following Tex Magic comments

  • % !TEX root = ../file.tex Select root file
  • % !TEX program = pdflatex Select Latex Engine (pdflatex,lualatex,xelatex)

Status

Please note that this package is in a beta state. Right now everything is very naïve. As an example, there's no proper error and warning handling.

TODO

Current wish list, in a semi-prioritized order.

  • Build output.
    • Error handling.
    • Warnings, and other non-critical messages.
  • BibTeX autocompletion support.
  • Add support for non-PDF typesetting (e.g. dvi).
  • Project management.
    • Setting to override the output directory.
    • Setting to override the builder.

If you see something that's missing, or disagree with the prioritization, consider submitting a feature request, and if you're feeling super helpful, submit a pull request with an updated TODO list 💖

atom-latex's People

Contributors

thomasjo avatar nscaife avatar m0nhawk avatar yorugac avatar boborbt avatar woodywoodsta avatar urdh avatar edjopato avatar evandromr avatar idleberg avatar lucas-clemente avatar maxxk avatar thedataking avatar robberphex avatar ahoereth avatar balu- avatar jacoblchapman avatar

Watchers

James Cloos avatar  avatar  avatar

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.