Kray-G / kinx-tiny-typesetting

Tiny typesetting system as an additional module for Kinx.

Kinx Tiny Typesetting

Introduction

Tiny typesetting system as an additional module for Kinx.

• KiTTy's User Guide.
  • User Guide in English ... (PDF)
  • User Guide in Japanese ... (PDF)

The above pdf files are also generated by KiTTy. KiTTy's source text is currently written in Markdown. Some text structures will be supported in future.

• The source text of KiTTy's User Guide.
  • User Guide in English ... (Markdown)
  • User Guide in Japanese ... (Markdown)

Installation

Kinx 1.1.x

Note that Kinx 1.1.0 is not released so far.

• Install Kinx 1.1.0 or above first.
• Install this typesetting package by the package manager.

$ kip install typesetting

Here are notes on using kip.

• If Kinx was installed under the system directory on Linux, add sudo before kip to take an administration privilege.
• If Kinx was installed via scoop on Windows, run kinx --install-path to set an execution path to the PATH environment at first.

Example

Markdown to PDF

Markdown Source

Here is the head of the source text of User Guide.

# Introduction

First, this section introduces a KiTTy itself and shows a comparison to alternative softwares,
and introduces a value of KiTTy and use case of KiTTy.
And also, it shows supported features.

## What is KiTTy

**KiTTy** means **Ki**nx **T**iny **Ty**pesetting,
which is a simple typesetting system implemented by Kinx.
It also provides a translator from Markdown,
then you can typeset a Markdown document and can get a beautiful document.
This document itself is also the example typeset by this system.

The objective is similar to \\LaTeX,
it is an objective to typeset beautifully for a document managed as a text file.
To be concretely, it is never going to be alternative,
but the objective is being more useful in the use case like your personal situation by followings.

*   Keeping a small system.
*   Pretty beautiful output.
*   Directly output as PDF file.

KiTTy is small but it has a simple feature to typeset it beautifully,
and it is a typesetting system to output PDF directly from Markdown document.

(...omitted...)

Output Image

This document is a Book Style, so the Chapter text will be started the odd page on the right side.

Table Of Contents

Table of contents will be automatically generated with the command toc below.

<toc with="lof,lot"/>

toc can have a list of tables and a list of figures. By the above command both lists are generated.

• lot ... List Of Tables
• lof ... List Of Figures

Cover Page

Cover page can have a cover image. Here is an example.

License

This project is licensed under the MIT License. See the LICENSE file for details. About the licenses of internal used libraries, follow the licenses of each library. See docs/licenses folder for details.