diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..1b5ec8b78 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/README.md b/README.md new file mode 100644 index 000000000..b29534a62 --- /dev/null +++ b/README.md @@ -0,0 +1,177 @@ +

+ Typst +

+ +

+ + Documentation + + + Typst App + + + Discord Server + + + Apache-2 License + +

+ +Typst is a new markup-based typsetting system that is designed to be as powerful +as LaTeX while being much easier to learn and use. Typst has: + +- Built-in markup for the most common formatting tasks +- Flexible functions for everything else +- A tightly integrated scripting system +- Math typesetting, bibliography management, and more +- Fast compile times thanks to incremental compilation +- Friendly error messages in case something goes wrong + +This repository contains the Typst compiler and its CLI, which is everything you +need to compile Typst documents locally. For the best writing experience, +consider signing up to our [collaborative online editor][app] for free. It is +currently in public beta. + +## Example +This is what a Typst file with a bit of math and automation looks like: +

+ Example +

+ +Let's disect what's going on: + +- We use _set rules_ to configure element properties like the size of pages or + the numbering of headings. By setting the page height to `auto`, it scales to + fit the content. Set rules accomodate the most common configurations. If you + need full control, you can also use [show rules][show] to completely redefine + the appearance of an element. + +- We insert a heading with the `= Heading` syntax. One equals sign creates a top + level heading, two create a subheading and so on. + +- [Math formulas][math] are enclosed in dollar signs. By adding extra spaces + around the contents of a formula, we can put it into a separate block. + Multi-letter identifiers are interpreted as Typst definitions and functions + unless put into quotes. This way, we don't need backslashes for things like + `floor` and `sqrt`. And `phi.alt` applies the `alt` modifier to the `phi` to + select a particular symbol variant. + +- Now, we get to some [scripting]. To input code into a Typst document, we can + write a hashtag followed by an expression. We define two variables and a + recursive function to compute the n-th fibonacci number. Then, we display the + results in a center-aligned table. The table function takes its cells + row-by-row. Therefore, we first pass the formulas `$F_1$` to `$F_10$` and then + the computed fibonacci numbers. We apply the spreading operator (`..`) to both + because they are arrays and we want to pass the arrays' items as individual + arguments. + +
+ Text version of the code example. + + ```text + #set page(width: 10cm, height: auto) + #set heading(numbering: "1.") + + = Fibonacci sequence + The Fibonacci sequence is defined through the + _recurrance relation_ $F_n = F_(n-1) + F_(n-2)$. + It can also be expressed in closed form: + + $ F_n = floor(1 / sqrt(5) phi.alt^n), quad + phi.alt = (1 + sqrt(5)) / 2 $ + + #let count = 10 + #let nums = range(1, count + 1) + #let fib(n) = ( + if n <= 2 { 1 } + else { fib(n - 1) + fib(n - 2) } + ) + + The first #count numbers of the sequence are: + + #align(center, table( + columns: count, + ..nums.map(n => $F_#n$), + ..nums.map(n => str(fib(n))), + )) + ``` +
+ +## Install and use +You can get sources and pre-built binaries for the latest release of Typst from +the [releases page][releases]. This will give you Typst's CLI which converts +Typst sources into PDFs. + +```sh +# Creates `file.pdf` in working directory. +typst file.typ + +# Creates PDF file at the desired path. +typst path/to/source.typ path/to/output.pdf +``` + +You can also watch source files and automatically recompile on changes. This is +faster than compiling from scratch each time because Typst has incremental +compilation. +```sh +# Watches source files and recompiles on changes. +typst --watch file.typ +``` + +If you prefer an integrated IDE-like experience, you can also check out the +[Typst web app][app], which is currently in public beta. + +## Build from source +To build Typst yourself, you need to have the [latest stable Rust][rust] +installed. Then, you can build the CLI with the following command: + +```sh +cargo build -p typst-cli --release +``` + +The optimized binary will be stored in `target/release/`. + +## Contributing +We would love to see contributions from the community. If you experience bugs, +feel free to open an issue or send a PR with a fix. For new features, we would +invite you to open an issue first so we can explore the design space together. +If you want to contribute and are wondering how everything works, also check out +the [`ARCHITECTURE.md`][architecture] file. It explains how the compiler works. + +## Design Principles +All of Typst has been designed with three key goals in mind: Power, +simplicity, and performance. We think it's time for a system that matches the +power of LaTeX, is easy to learn and use, all while being fast enough to realize +instant preview. To achieve these goals, we follow three core design principles: + +- **Simplicity through Consistency:** + If you know how to do one thing in Typst, you should be able to transfer that + knowledge to other things. If there are multiple ways to do the same thing, + one of them should be at a different level of abstraction than the other. E.g. + it's okay that `= Introduction` and `#heading[Introduction]` do the same thing + because the former is just syntax sugar for the latter. + +- **Power through Composability:** + There are two ways to make something flexible: Have a knob for everything or + have a few knobs that you can combine in many ways. Typst is designed with the + second way in mind. We provide systems that you can compose in ways we've + never even thought of. TeX is also in the second category, but it's a bit + low-level and therefore people use LaTeX instead. But there, we don't really + have that much composability. Instead, there's a package for everything + (`\usepackage{knob}`). + +- **Performance through Incrementality:** + All Typst language features must accomodate for incremental compilation. + Luckily we have [`comemo`], a system for incremental compilation which does + most of the hard work in the background. + +[docs]: https://typst.app/docs +[app]: https://typst.app/ +[discord]: https://discord.gg/2uDybryKPe +[show]: https://typst.app/docs/reference/styling/#show-rules +[math]: https://typst.app/docs/reference/math/ +[scripting]: https://typst.app/docs/reference/scripting/ +[rust]: https://rustup.rs +[releases]: https://github.com/typst/typst/releases +[architecture]: https://github.com/typst/typst/blob/main/ARCHITECTURE.md +[`comemo`]: https://github.com/typst/comemo/