# reticule > A new way to write and explore mathematical texts. Latest version **0.1.6** (published 2017-05-20) · MIT license · 0 weekly downloads ## Install ```sh npm install reticule pnpm add reticule yarn add reticule bun add reticule ``` Provides the command `reticule`. ## Health **Score 5/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score; declining downloads. ## Facts | | | |---|---| | Version | 0.1.6 | | Published | 2017-05-20 | | First published | 2015-12-20 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 5 | | Known vulnerabilities | 0 (+3 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 23 | | Author | Yichuan Shen | | Maintainers | yishn | ## Links - npm: https://www.npmjs.com/package/reticule - Repository: https://github.com/yishn/reticule - Homepage: https://github.com/yishn/reticule#readme - Issues: https://github.com/yishn/reticule/issues - npm.io page: https://npm.io/package/reticule ## Dependencies (5) - [marked](https://npm.io/package/marked.md) ^0.3.5 - [minimist](https://npm.io/package/minimist.md) ^1.2.0 - [diacritic](https://npm.io/package/diacritic.md) ^0.0.2 - [milk-lang](https://npm.io/package/milk-lang.md) ^0.1.6 - [uglify-js](https://npm.io/package/uglify-js.md) ^2.5.0 ## Recent versions - 0.1.6 (latest) — 2017-05-20 - 0.1.5 — 2016-07-20 - 0.1.4 — 2016-07-17 - 0.1.3 — 2016-01-25 - 0.1.2 — 2016-01-25 - 0.1.1 — 2015-12-20 - 0.1.0 — 2015-12-20 ## README # reticule [![npm version](https://badge.fury.io/js/reticule.svg)](https://badge.fury.io/js/reticule) A new way to write and explore mathematical texts. ![Animation](animation.gif) # Getting Started ## Table of Contents * [Installation](#installation) * [Book Structure](#book-structure) * [Meta Information](#meta-information) * [Book Sections](#book-sections) * [Tags](#tags) * [Creating Index](#creating-index) * [TeX Macros](#tex-macros) * [Compilation](#compilation) ## Installation Make sure you have [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed. To install reticule, run: npm install -g reticule ## Book Structure To create a book, create a folder with the following text files: root/ ├ book.json └ toc.md ## Meta Information `book.json` contains all meta-information regarding your book, such as the title and the author. `toc.md` contains the table of contents of your book. It defines all sections and links to the corresponding files. `book.json` contains an JSON object with the following properties: Property | Description :----------------------|:--------------------------------------- `title` * | The book title. No markdown allowed. `author` * | The book author(s). Markdown allowed. `accent` | Defines an accent color in hex. Default: `#327CCB` `lang` | Defines the book language. Affects CSS hyphenation. Default: `en` `github` | The link to a GitHub repository. If defined, every page has a 'GitHub' and an 'Edit page' link. `disqus` | The shortname of your Disqus website. Provides Disqus comment system integration if defined. `localization` | An object containing alternate strings. Translatable strings: `¶`, `$\square$`, `Proof`, `Table of Contents`, `Index`, `GitHub`, `Edit page`, `Generated by reticule` \* Required properties ### Example ~~~json { "title": "Étale Kohomologie", "author": "Yichuan Shen", "lang": "de", "localization": { "Proof": "Beweis", "Table of Contents": "Inhaltsverzeichnis", "Edit page": "Seite bearbeiten", "Generated by reticule": "Erstellt mit reticule", "$\\square$": "Q.E.D." } } ~~~ ## Book Sections For each section create a folder with a `tags.md` file: root/ ├ section1/ │ └ tags.md ├ section2/ │ └ tags.md ├ subsection/ | └ section3/ │ └ tags.md │ ├ book.json └ toc.md Also, provide the book structure in `toc.md` as an unordered list: ~~~md * [Section 1](section1/) * [Section 2](section2/) * Subsection * [Section 3](subsection/section3/) ~~~ Don't use the folder name `index` as it's reserved for the automatically generated index. ## Tags Tags are the building blocks of a reticule. A tag consists of two parts: An assertion and an optional proof. To create a tag, choose a unique tag id, e.g. `#0ABC` or `#1ABC`, and write the content: ~~~md #0ABC There are infinitely many primes. #1ABC:Dirichlet's Theorem Let `a, b` be coprime numbers. There are infinitely many primes congruent `a` modulo `b`. ~~~ Tag ids start with a hash symbol `#` followed by alphanumeric characters or the hyphen `-`. You can name the tag by appending a colon and a name to the id. To provide a proof, add a horizontal line: ~~~md #0ABC:Theorem There are infinitely many primes. --- Suppose there are only finite primes `p_1,\ldots,p_n`. Observe that `p_1\cdot p_2\cdots p_n + 1` has a prime divisor `p`, distinct from `p_1,\ldots,p_n`. ~~~ [Markdown](https://daringfireball.net/projects/markdown/) is used for formatting. Code spans and code blocks are converted into math environments and rendered by [MathJax](https://www.mathjax.org/) and [XyJax](http://sonoisa.github.io/xyjax/xyjax.html). To link to other tags, use a markdown link and and the tag id as the source: ~~~md #0ABC:Theorem There are infinitely many primes. --- Putting `a = 1` and `b = 2` in [~](#1ABC) yields infinitely many odd primes. ~~~ ## Creating Index To add a keyword to the index, just append the keyword, wrapped in `~~`, anywhere in the tag: ~~~md #1ABC:Dirichlet's Theorem Let `a, b` be coprime numbers. There are infinitely many primes congruent `a` modulo `b`. ~~Dirichlet's Theorem~~ ~~~ You can add a context to a keyword by appending `|` and the context to the keyword: ~~~md #1ABC:Dirichlet's Theorem Let `a, b` be coprime numbers. There are infinitely many primes congruent `a` modulo `b`. ~~Dirichlet's Theorem|Number Theory~~ ~~~ ## TeX Macros You can define custom TeX macros that can be used throughout your book. Simply add a file named `macros.tex` with the user-defined macros to the root folder: root/ ├ book.json ├ toc.md └ macros.tex ## Compilation To compile a reticule book into a website, navigate to your book directory and simply run: reticule --- _Source: https://npm.io/package/reticule · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._