caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-05-14 04:56:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation changes

Browse Source
This commit is contained in:
Laurenz 2023-03-21 18:20:15 +01:00
parent 53b57d8294
commit 4428646c99
3 changed files with 17 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/src/general/community.md
View File

@ -6,7 +6,7 @@ description: |
# Community # Community
Hey and welcome to the Community page! We're so glad you're here. Typst is 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 developed by an early-stage startup and is still in its infancy, but it
would be pointless without people like you who are interested in 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 We would love to not only hear from you but to also provide spaces where you can
@ -34,22 +34,16 @@ community members, but if you need a little inspiration, here are a few ideas:
- Share importable files or templates that you use to style your documents - Share importable files or templates that you use to style your documents
- Alert us of bugs you encounter while using Typst - Alert us of bugs you encounter while using Typst
## Infrastructure test ## Beta test
We will start a small-scale test of our product and infrastructure with a few We are starting a public beta test of our product on March 21st, 2022.
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 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 occur at any point. The compiler is developed in the open on
public beta. Currently, we plan to start our public beta and open source Typst [GitHub](https://github.com/typst/typst).
in March of 2023.
We will update the members of our Discord server and our social media followers 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 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 development progress of large features. A development tracker will become
tracker will become available on the documentation pages soon. available on the documentation pages soon.
## Community Rules ## Community Rules
We want to make our community a safe and inclusive space for everyone. We want to make our community a safe and inclusive space for everyone.

5
docs/src/general/overview.md
View File

@ -5,7 +5,10 @@ description: |
--- ---
# Overview # 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. 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. Our goal with Typst is
to build a typesetting tool that is highly capable _and_ a pleasure to 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. 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.

22
docs/src/tutorial/welcome.md
View File

@ -9,9 +9,10 @@ introduce more advanced features. This tutorial does not assume prior knowledge
of Typst, other Markup languages, or programming. We do assume that you know how of Typst, other Markup languages, or programming. We do assume that you know how
to edit a text file. to edit a text file.
The best way to start is to open the Typst app and follow along with the The best way to start is to sign up to the Typst app for free and follow along
steps below. Do not have preview access yet? with the steps below. The app gives you instant preview, syntax highlighting and
[Sign up for the wait list](https://typst.app). helpful autocompletions. Alternatively, you can follow along in your local text
editor with the [open-source CLI](https://github.com/typst/typst).
## When to use Typst ## When to use Typst
Before we get started, let's check what Typst is and when to use it. Typst is a Before we get started, let's check what Typst is and when to use it. Typst is a
@ -26,20 +27,9 @@ in the math, physics, and engineering fields. Finally, due to its strong styling
and automation features, it is an excellent choice for any set of documents that and automation features, it is an excellent choice for any set of documents that
share a common style, such as a book series. share a common style, such as a book series.
## How to get access to Typst
Starting December 26th, 2022, we are conducting a closed infrastructure test
into which we invite a small number of people from our wait list. A few months
later we will start a public beta of our web app and open source Typst
(currently planned for March of 2023).
At that point, we will also give you the option to download a local command line
compiler for Typst. This way, you can always compile your documents
independently from our web app. Still, the web app offers many useful feature
like live preview, autocompletion and collaboration for teams.
## What you will learn ## What you will learn
This tutorial has four chapters. Each chapter builds on the previous one. Here is This tutorial has four chapters. Each chapter builds on the previous one. Here
what you will learn in each of them: is what you will learn in each of them:
1. [Writing in Typst:]($tutorial/writing-in-typst) Learn how to write text and 1. [Writing in Typst:]($tutorial/writing-in-typst) Learn how to write text and
insert images, equations, and other elements. insert images, equations, and other elements.