Giter VIP home page Giter VIP logo

laxidian's Introduction

LaXidiaN

A LaTeX template inspired by Obisdian.

Contributors last commit

PRs Welcome stars stars

LaXidiaN

LaXidiaN is a LaTeX template inspired by Obsidian for taking notes.

Features

This template features:

  • Unbreakable callout boxes. There are four types of callout boxes: success, danger, info and warning.
  • Custom callout boxes. You can create your own callout box if you have specifc needs.
  • Referencable callout boxes. You can create a reference to one or more of your callout boxes and re-use them later in the document.
  • Pre-defined mathematical operators and expression.
  • Custom images and tables fitting and formatting.
  • Custom theorems, proofs and quotes.

Template structure

The template is structured as follows:

  • packages.sty, it contains all the packages used for styling and defining new commands;
  • definitions.sty, it contains all the definitions of the mathematical operators and expressions;
  • styles.sty, here are defined the styles for the various callout boxes, along with the theorems, proofs and quotes.

Set up your VsCode Environment

In order to write and compile LaTeX on VsCode, install the LaTeX Workshop extension on the marketplace.
Once you have enabled it, open the extension's settings and set the Out Dir option to %TMPDIR%, like illustrated below. This will ensure that all compiled files will be placed in a temporary directory and not in your current working directory.

immagine

Finally, edit your settings.json file and paste the following code:

"latex-workshop.latex.tools": [
        {
            "name": "latexmk",
            "command": "latexmk",
            "args": [
                "-shell-escape",
                "-synctex=1",
                "-interaction=nonstopmode",
                // "-file-line-error",
                "-pdf",
                "-outdir=%TMPDIR%",
                "%DOC%"
            ],
            "env": {}
        },
        {
            "name": "lualatexmk",
            "command": "latexmk",
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-lualatex",
                "-outdir=%OUTDIR%",
                "%DOC%"
            ],
            "env": {}
        },
        {
            "name": "xelatexmk",
            "command": "latexmk",
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-xelatex",
                "-outdir=%OUTDIR%",
                "%DOC%"
            ],
            "env": {}
        },
        {
            "name": "latexmk_rconly",
            "command": "latexmk",
            "args": [
                "%DOC%"
            ],
            "env": {}
        },
        {
            "name": "pdflatex",
            "command": "pdflatex",
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "%DOC%"
            ],
            "env": {}
        },
        {
            "name": "bibtex",
            "command": "bibtex",
            "args": [
                "%DOCFILE%"
            ],
            "env": {}
        },
        {
            "name": "rnw2tex",
            "command": "Rscript",
            "args": [
                "-e",
                "knitr::opts_knit$set(concordance = TRUE); knitr::knit('%DOCFILE_EXT%')"
            ],
            "env": {}
        },
        {
            "name": "jnw2tex",
            "command": "julia",
            "args": [
                "-e",
                "using Weave; weave(\"%DOC_EXT%\", doctype=\"tex\")"
            ],
            "env": {}
        },
        {
            "name": "jnw2texminted",
            "command": "julia",
            "args": [
                "-e",
                "using Weave; weave(\"%DOC_EXT%\", doctype=\"texminted\")"
            ],
            "env": {}
        },
        {
            "name": "pnw2tex",
            "command": "pweave",
            "args": [
                "-f",
                "tex",
                "%DOC_EXT%"
            ],
            "env": {}
        },
        {
            "name": "pnw2texminted",
            "command": "pweave",
            "args": [
                "-f",
                "texminted",
                "%DOC_EXT%"
            ],
            "env": {}
        },
        {
            "name": "tectonic",
            "command": "tectonic",
            "args": [
                "--synctex",
                "--keep-logs",
                "%DOC%.tex"
            ],
            "env": {}
        }
    ],
    "latex-workshop.latex.autoClean.run": "onBuilt",
    "latex-workshop.latex.clean.subfolder.enabled": true,
    "latex-workshop.latex.outDir": "%TMPDIR%",
    "latex-workshop.message.warning.show": false,

Contributing

If you'd like to contribute to the project, please:

  1. Create a fork of this repository;
  2. Clone the newly created fork;
  3. Create a branch named with the feature/fix you would like to implement, for example: git branch -m fix-boxes
  4. Create a pull request and wait for approval;

Cmon, join our contributors:

License

This template is distributed under the GNU General Public License v3.0.

laxidian's People

Contributors

angelonazzaro avatar robertodr01 avatar

Stargazers

Andrea Terlizzi 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.