Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/swagdevops/aldine

LaTeX utilities (standalone document preparation system)
https://github.com/swagdevops/aldine

docker latex template tex

Last synced: 8 days ago
JSON representation

LaTeX utilities (standalone document preparation system)

Awesome Lists containing this project

README

        

## Install

```shell
bundle config set --local clean 'true'
bundle config set --local path 'vendor/bundle'
bundle install --standalone
```

## Rakefile

### ``./Rakefile``

```ruby
# frozen_string_literal: true

require 'bundler/setup'
require 'aldine/local/tasks'
```

## Environment

The following files are loaded as [``dotenv``][bkeepers/dotenv] files:

* ``.env.local``
* ``.env``

The file ``.env.sample`` is used to perform [environment validation][fastruby/dotenv_validator].

See also:
* [Dotenv][bkeepers/dotenv]
* [Dotenv Validator][fastruby/dotenv_validator]

## Aliasing

LaTeX commands provided by the package can be aliased (to be more semantic), as the following __example__:

```latex
% aldine --------------------------------------------------------------
\DeclareCommandCopy\emptypage\aldineEmptyPage
\DeclareCommandCopy\markdown\aldineMarkdown
\DeclareCommandCopy\svgconv\aldineSvgConv
\DeclareCommandCopy\blason\aldineBlason
\DeclareCommandCopy\chapters\aldineChapters
\DeclareCommandCopy\hyperrefSetup\aldineHyperrefSetup
\DeclareCommandCopy\imageFull\aldineImageFull
```

## Developper

### Environment

```dotenv
# file: .env.local

ALDINE__DIRECTORIES__LIB=tex
ALDINE__DIRECTORIES__RUBY=lib
```

Dotenv above changes ``lib`` to ``tex`` for tex packages,
and add ruby ``lib`` directory to mounted directories.
It assumes working from the current sources directory.

### Replacement ``Rakefile`` in ``src`` and ``tmp`` directory

```ruby
# frozen_string_literal: true

require 'bundler/setup'
require '/workdir/lib/aldine'
require 'aldine/remote/tasks'
```

[bkeepers/dotenv]: https://github.com/bkeepers/dotenv
[fastruby/dotenv_validator]: https://github.com/fastruby/dotenv_validator