summaryrefslogtreecommitdiff
path: root/docs/src/general
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2023-02-06 11:50:03 +0100
committerLaurenz <laurmaedje@gmail.com>2023-02-06 11:50:03 +0100
commit0bb0f1c98fc8eff5d7556bbe9d5801f02237a5c0 (patch)
tree83bce472d527cb62c6b6d048059921d8404074fd /docs/src/general
parent2e87dcdbe014a5327395cfcd138b547426a50e6e (diff)
Import documentation
Co-Authored-By: Martin Haug <mhaug@live.de>
Diffstat (limited to 'docs/src/general')
-rw-r--r--docs/src/general/changelog.md111
-rw-r--r--docs/src/general/community.md69
-rw-r--r--docs/src/general/overview.md12
3 files changed, 192 insertions, 0 deletions
diff --git a/docs/src/general/changelog.md b/docs/src/general/changelog.md
new file mode 100644
index 00000000..30608024
--- /dev/null
+++ b/docs/src/general/changelog.md
@@ -0,0 +1,111 @@
+---
+description: |
+ Learn what has changed in the latest Typst releases and move your documents
+ forward.
+---
+
+# Changelog
+## February 2, 2023
+- Merged text and math symbols, renamed a few symbols
+ (including `infty` to `infinity` with the alias `oo`)
+- Fixed missing italic mappings
+- Math italics correction is now applied properly
+- Parentheses now scale in `[$zeta(x/2)$]`
+- Fixed placement of large root index
+- Fixed spacing in `[$abs(-x)$]`
+- Fixed inconsistency between text and identifiers in math
+- Accents are now ignored when positioning superscripts
+- Fixed vertical alignment in matrices
+- Fixed `text` set rule in `raw` show rule
+- Heading and list markers now parse consistently
+- Allow arbitrary math directly in content
+
+## January 30, 2023
+[Go to the announcement blog post.](https://typst.app/blog/2023/january-update)
+- New expression syntax in markup/math
+ - Blocks cannot be directly embedded in markup anymore
+ - Like other expressions, they now require a leading hashtag
+ - More expressions available with hashtag, including literals
+ (`[#"string"]`) as well as field access and method call
+ without space: `[#emoji.face]`
+- New import syntax
+ - `[#import "module.typ"]` creates binding named `module`
+ - `[#import "module.typ": a, b]` or `[#import "module.typ": *]` to import items
+ - `[#import emoji: face, turtle]` to import from already bound module
+- New symbol handling
+ - Removed symbol notation
+ - Symbols are now in modules: `{sym}`, `{emoji}`, and `{math}`
+ - Math module also reexports all of `{sym}`
+ - Modified through field access, still order-independent
+ - Unknown modifiers are not allowed anymore
+ - Support for custom symbol definitions with `symbol` function
+ - Symbols now listed in documentation
+- New `{math}` module
+ - Contains all math-related functions
+ - Variables and function calls directly in math (without hashtag) access this
+ module instead of the global scope, but can also access local variables
+ - Can be explicitly used in code, e.g. `[#set math.vec(delim: "[")]`
+- Delimiter matching in math
+ - Any opening delimiters matches any closing one
+ - When matched, they automatically scale
+ - To prevent scaling, escape them
+ - To forcibly match two delimiters, use `lr` function
+ - Line breaks may occur between matched delimiters
+ - Delimiters may also be unbalanced
+ - You can also use the `lr` function to scale the brackets
+ (or just one bracket) to a specific size manually
+- Multi-line math with alignment
+ - The `\` character inserts a line break
+ - The `&` character defines an alignment point
+ - Alignment points also work for underbraces, vectors, cases, and matrices
+ - Multiple alignment points are supported
+- More capable math function calls
+ - Function calls directly in math can now take code expressions with hashtag
+ - They can now also take named arguments
+ - Within math function calls, semicolons turn preceding arguments to arrays to
+ support matrices: `[$mat(1, 2; 3, 4)$]`
+- Arbitrary content in math
+ - Text, images, and other arbitrary content can now be embedded in math
+ - Math now also supports font fallback to support e.g. CJK and emoji
+- More math features
+ - New text operators: `op` function, `lim`, `max`, etc.
+ - New matrix function: `mat`
+ - New n-ary roots with `root` function: `[$root(3, x)$]`
+ - New under- and overbraces, -brackets, and -lines
+ - New `abs` and `norm` functions
+ - New shorthands: `[|`, `|]`, and `||`
+ - New `attach` function, overridable attachments with `script` and `limit`
+ - Manual spacing in math, with `h`, `thin`, `med`, `thick` and `quad`
+ - Symbols and other content may now be used like a function, e.g. `[$zeta(x)$]`
+ - Added Fira Math font, removed Noto Sans Math font
+ - Support for alternative math fonts through
+ `[#show math.formula: set text("Fira Math")]`
+- More library improvements
+ - New `calc` module, `abs`, `min`, `max`, `even`, `odd` and `mod` moved there
+ - New `message` argument on `{assert}` function
+ - The `pairs` method on dictionaries now returns an array of length-2 arrays
+ instead of taking a closure
+ - The method call `{dict.at("key")}` now always fails if `"key"` doesn't exist
+ Previously, it was allowed in assignments. Alternatives are `{dict.key = x}`
+ and `{dict.insert("key", x)}`.
+- Smarter editor functionality
+ - Autocompletion for local variables
+ - Autocompletion for methods available on a value
+ - Autocompletion for symbols and modules
+ - Autocompletion for imports
+ - Hover over an identifier to see its value(s)
+- Further editor improvements
+ - New Font menu with previews
+ - Single projects may now be shared with share links
+ - New dashboard experience if projects are shared with you
+ - Keyboard Shortcuts are now listed in the menus and there are more of them
+ - New Offline indicator
+ - Tooltips for all buttons
+ - Improved account protection
+ - Moved Status indicator into the error list button
+- Fixes
+ - Multiple bug fixes for incremental parser
+ - Fixed closure parameter capturing
+ - Fixed tons of math bugs
+ - Bugfixes for performance, file management, editing reliability
+ - Added redirection to the page originally navigated to after signin
diff --git a/docs/src/general/community.md b/docs/src/general/community.md
new file mode 100644
index 00000000..3654e9fe
--- /dev/null
+++ b/docs/src/general/community.md
@@ -0,0 +1,69 @@
+---
+description: |
+ Join the Typst community, get help from other users and have a say in the
+ future of Typst.
+---
+
+# Community
+Hey and welcome to the Community page! We're so glad you're here. Typst is
+developed by a super early-stage startup and is still in its infancy, but it
+would be pointless without people like you who are interested in it.
+
+We would love to not only hear from you but to also provide spaces where you can
+discuss any topic around Typst, typesetting, writing, the sciences, and
+typography with other likeminded people.
+
+For the time being, **we would like to invite you to our [Discord
+server](https://discord.gg/2uDybryKPe).** The server is open for everyone, even
+if you do not have preview access to Typst yet. Of course, you are also very
+welcome to connect with us on social media
+([Twitter](https://twitter.com/typstapp/),
+[Instagram](https://instagram.com/typstapp/),
+[LinkedIn](https://linkedin.com/company/typst), and
+[Github](https://github.com/typst)).
+
+## What to share?
+For our community, we want to foster versatility and inclusivity.
+You are welcome to post about any topic that you think would interest other
+community members, but if you need a little inspiration, here are a few ideas:
+
+- Share and discuss your thoughts and ideas for new features or improvements
+ you'd like to see in Typst
+- Showcase documents you've created with Typst, or share any unique or creative
+ ways you've used the platform
+- Share importable files or templates that you use to style your documents
+- Alert us of bugs you encounter while using Typst
+
+## Infrastructure test
+We will start a small-scale test of our product and infrastructure with a few
+people from our wait list, starting on December 26th, 2022. More wait list
+members will be invited throughout the infrastructure test. Everyone who has
+product access and is on our Discord server will receive access to a private
+text and speech channel.
+
+The Typst compiler is still under active development and breaking changes can
+occur at any point. The compiler will remain closed source until Typst goes into
+public beta. Currently, we plan to start our public beta and open source Typst
+in March of 2023.
+
+We will update the members of our Discord server and our social media followers
+when new features become available in the preview. We'll also update you on the
+development progress of large features, such as math typesetting. A development
+tracker will become available on the documentation pages soon.
+
+## Community Rules
+We want to make our community a safe and inclusive space for everyone.
+Therefore, we will not tolerate any sexual harassment, sexism, political
+attacks, derogatory language or personal insults, racism, doxing, and other
+inappropriate behavior. We pledge to remove members that are in violation of
+these rules. [Contact us](https://typst.app/contact/) if you think another
+community member acted inappropriately towards you. All complaints will be
+reviewed and investigated promptly and fairly.
+
+In addition, our [privacy policy](https://typst.app/privacy/) applies on all
+community spaces operated by us, such as the Discord server. Please also note
+that the terms of service and privacy policies of the respective services apply.
+
+## See you soon!
+Thanks again for learning more about Typst. We would be delighted to meet you on
+our [Discord server](https://discord.gg/2uDybryKPe)!
diff --git a/docs/src/general/overview.md b/docs/src/general/overview.md
new file mode 100644
index 00000000..f63e46e9
--- /dev/null
+++ b/docs/src/general/overview.md
@@ -0,0 +1,12 @@
+---
+description: |
+ Learn how to use Typst to compose documents faster. Get started with the
+ tutorial, or dive into the reference.
+---
+
+# Overview
+Welcome to Typst's documentation! Typst is a new markup-based typesetting system for the sciences. It is designed to be an alternative both to advanced tools like LaTeX and simpler tools like Word and Google Docs. Typst's focus lies on the intersection of simplicity and power. We are building a highly capable tool that is at the same time easy to understand and use.
+
+This documentation is split into two parts: A beginner-friendly tutorial that introduces Typst through a practical use case and a comprehensive reference that explains all of Typst's concepts and features.
+
+We also invite you to join the community we're building around Typst. Typst is still a very young project, so your feedback is more than valuable.