codly:1.3.1

packages/preview/codly/1.3.1/.gitignore

@@ -0,0 +1,8 @@
+# added by typst-test
+tests/*/out/**
+tests/*/diff/**
+test*.png
+record-*.json
+_*@bench/
+report/
+.DS_STORE

packages/preview/codly/1.3.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2023] [Sébastien d'Herbais de Thun, et al.]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/preview/codly/1.3.1/README.md

@@ -0,0 +1,239 @@
+# Codly: simple yet beautiful and powerful code blocks
+
+<p align="center">
+  <a href="https://github.com/Dherse/codly/blob/main/docs.pdf">
+    <img alt="Documentation" src="https://img.shields.io/website?down_message=offline&label=manual&up_color=007aff&up_message=online&url=https%3A%2F%2Fgithub.com%2FDherse%2Fcodly%2Fblob%2Fmain%2Fdocs.pdf" />
+  </a>
+  <a href="https://github.com/Dherse/codly/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/badge/license-MIT-brightgreen">
+  </a>
+  <img src="https://github.com/Dherse/codly/actions/workflows/test.yml/badge.svg" />
+</p>
+
+Codly superchargescode blocks for your Typst documents. It allows you to add annotations, skip lines, customize numberings, add language icons, and much more. Codly is even better with its companion package [`codly-languages`](https://typst.app/universe/package/codly-languages) which provides a wide range of language icons and colors to choose from.
+
+A full set of documentation can be found [in the repo](https://raw.githubusercontent.com/Dherse/codly/main/docs.pdf).
+
+![Example](./assets/demo.png)
+
+````typ
+#import "@preview/codly:1.3.1": *
+#import "@preview/codly-languages:0.1.1": *
+#show: codly-init.with()
+
+#codly(languages: codly-languages)
+```rust
+pub fn main() {
+    println!("Hello, world!");
+}
+```
+````
+
+### Setup
+
+To start using codly, you need to initialize codly using a show rule, this need only be done once per document:
+
+```typ
+#show: codly-init.with()
+```
+
+Then you *can* configure codly with your parameters:
+
+```typ
+#codly(
+  languages: (
+    rust: (name: "Rust", icon: "🦀", color: rgb("#CE412B")),
+  )
+)
+```
+
+---
+**Note**: Any parameter that you leave blank will use the previous values (or the default value if never set) similar to a `set` rule in regular typst. But the changes are always global unless you use the provided `codly.local` function. To get a full list of all settings, see the [documentation](https://raw.githubusercontent.com/Dherse/codly/main/docs.pdf).
+
+---
+
+Then you just need to add a code block and it will be automatically displayed correctly:
+
+````
+```rust
+pub fn main() {
+    println!("Hello, world!");
+}
+```
+````
+
+![Crab](./assets/crab.png)
+
+### Disabling & Enabling
+
+To locally disable codly, you can just do the following, you can then later re-enable it using the `codly` configuration function.
+
+```typ
+#codly-disable()
+```
+
+![codly-disable](./assets/codly-disable.png)
+
+Alternatively, you can use the `no-codly` function to achieve the same effect locally:
+
+````typ
+#no-codly[
+  ```typ
+  I will be displayed using the normal raw blocks.
+  ```
+]
+````
+
+### Smart indentation
+
+By default Codly ships with `smart-indent` enabled, this means that Codly will automatically detect the indentation of your code block and adjust the horizontal offset on line wrapping accordingly. This can be disabled using the `smart-indent` parameter.
+
+```typ
+#codly(smart-indent: false)
+```
+
+![smart-ident](./assets/smart-indent.png)
+
+### Referencing code blocks
+
+Codly offers a wide range of features for referencing code blocks, lines, highlights, and annotations. This is done using:
+- the line shorthand `@<label>:<line>`
+- the highlight or annotation label `@<highlight>`
+
+![line-ref](./assets/line-ref.png)
+
+![highlight-ref](./assets/highlight-ref.png)
+
+### Setting an offset
+
+If you wish to add an offset to your code block, but without selecting a subset of lines, you can use the `codly-offset` function:
+
+```typ
+// Sets a 5 line offset
+#codly-offset(5)
+```
+
+![codly-offset](./assets/codly-offset.png)
+
+### Setting an offset relative to another code block
+
+This is done by using the `offset-from` argument and by specifying a Typst `label` to the "parent" code block:
+
+````typ
+#codly(offset-from: <parent>)
+````
+
+![offset-from](./assets/offset-from.png)
+
+### Selecting a subset of lines
+
+If you wish to select a subset of lines, you can use the `codly-range` function. By setting the start to 1 and the end to `none` you can select all lines from the start to the end of the code block.
+
+```typ
+#codly-range(start: 5, end: 10)
+```
+
+![codly-range](./assets/codly-range.png)
+
+### Adding a "skip"
+
+You can add a "fake" skip between lines using the `skips` parameters:
+
+```typ
+// Before the 5th line (indexing start at 0), insert a 32 line jump.
+#codly(skips: ((5, 32), ))
+```
+The code inside your block will be the same (except for the added line containing the … character), but the line numbers will be adjusted to reflect the skip. 
+
+This can be customized using the `skip-line` and `skip-number` to customize what it looks like.
+
+### Adding highlights
+
+You can highlight part of lines using the `highlights` parameters:
+
+````typ
+#codly(highlights: (
+  (line: 4, start: 2, end: none, fill: red),
+  (line: 5, start: 13, end: 19, fill: green, tag: "(a)"),
+  (line: 5, start: 26, fill: blue, tag: "(b)"),
+))
+```py
+def fib(n):
+  if n <= 1:
+    return n
+  else:
+    return fib(n - 1) + fib(n - 2)
+print(fib(25))
+```
+````
+
+![highlights](./assets/highlights.png)
+
+### Adding annotations
+
+You can annotate a line/group of lines using the `annotations` parameters :
+
+```typ
+// Add an annotation from the second line (0 indexing) to the 5th line included.
+#codly(
+  annotations: (
+    (
+      start: 2,
+      end: 4,
+      content: block(
+        width: 2em,
+        // Rotate the element to make it look nice
+        rotate(
+          -90deg,
+          align(center, box(width: 100pt)[Function body])
+        )
+      )
+    ), 
+  )
+)
+```
+
+![annotations](./assets/annotations.png)
+
+### Disabling line numbers
+
+You can configure this with the `codly` function:
+
+```typ
+#codly(number-format: none)
+```
+
+### Disabling zebra striping
+
+You disable zebra striping by setting the `zebra-fill` to white or none.
+
+```typ
+#codly(zebra-fill: none)
+```
+
+### Customize the stroke
+
+You can customize the stroke surrounding the figure using the `stroke` parameter of the `codly` function:
+
+```typ
+#codly(stroke: 1pt + red)
+```
+
+### Misc
+
+You can also disable the icon by setting the `display-icon` parameter to `false`:
+
+```typ
+#codly(display-icon: false)
+```
+
+This applies to:
+- the name
+- the radius
+- whether the block is breakable
+- the padding
+- the width of the numbers columns 
+
+and so many more.
+
+For more detailed information check out the [documentation](https://raw.githubusercontent.com/Dherse/codly/main/docs.pdf).