NoTeX

A modern noteworthy LaTeX template.

Documentation

View Demo

Report Bug

Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Requirements
   • Installation
3. Usage
4. Contributing
5. License
6. Acknowledgments

About The Project

NoTeX is a modern LaTeX template paired with a companion CLI utility to help you create, manage, and maintain your LaTeX-based projects. The template is designed to be modular, flexible, and easy to use, while the CLI utility automates many of the routine tasks associated with LaTeX project management.

graph LR
    subgraph cli ["<b>notex CLI</b>"]
        bin["<code>notex</code><br> <i>Installation and management.</i>"]
    end

    subgraph latex ["<b>LaTeX Template</b>"]
        cls["<code>notex.cls</code><br> <i>Themes, callouts,<br>code, and more.</i>"]
    end

    subgraph project ["<b>Your Project</b>"]
        doc["<code>main.tex</code>"]
    end

    bin -- "installs" --> cls
    bin -- "operates &amp; manages" --> doc
    cls -- "provides template" --> doc

Loading

The Implementation guide explains the details of how the notex CLI utility itself is built, while the Usage guide documentation section explains how to use the template and the CLI utility to create and manage your beautiful LaTeX projects.

Built With

↑ back to top

Getting Started

Requirements

To build the C++ utility from source and use the LaTeX template you need:

• CMake (version >= 3.20)
• C++20 compiler
• A LaTeX distribution with LuaLaTeX
• Pygments (pip install Pygments)

See the Installation guide for a complete list of all TeX Live packages required.

Installation

The Installation guide provides detailed instructions on different way to install the NoTeX project. See those pages for additional details. Here, a quick start guide is provided to get you up and running as quickly as possible.

Clone the repository and run the global install script, which builds notex, installs it on your PATH, and installs the LaTeX template system-wide in one step:

git clone https://github.com/marcotallone/notex.git
cd notex
sudo ./install.sh global

Check that everything is set up with:

notex info

and start a new project with:

notex init my-notes

↑ back to top

Usage

The notex CLI manages themes, sections, bibliographies, and cleanup for a project, while the LaTeX template itself provides the callout blocks, code environments, and styling you'll use while writing. See the Usage guide for the full command reference and a tour of the template's features, and the PDF documentation for a compiled, worked example of everything the template offers.

↑ back to top

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star ⭐! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

↑ back to top

License

Distributed under the MIT License. See LICENSE.txt for more information.

↑ back to top

Acknowledgments

• Best-README-Template

↑ back to top