mirror of
https://github.com/typst/typst
synced 2025-05-13 20:46:23 +08:00
Move roadmap and community pages out of this repository (#4688)
This commit is contained in:
Laurenz
GitHub
parent
6856d5e672
commit
cd02ae709f
@ -32,8 +32,7 @@ as LaTeX while being much easier to learn and use. Typst has:
|
||||
|
||||
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.
|
||||
consider signing up to our [collaborative online editor][app] for free.
|
||||
|
||||
## Example
|
||||
A [gentle introduction][tutorial] to Typst is available in our documentation.
|
||||
@ -173,8 +172,7 @@ typst help watch
|
||||
```
|
||||
|
||||
If you prefer an integrated IDE-like experience with autocompletion and instant
|
||||
preview, you can also check out the [Typst web app][app], which is currently in
|
||||
public beta.
|
||||
preview, you can also check out [Typst's free web app][app].
|
||||
|
||||
## Community
|
||||
The main place where the community gathers is our [Discord server][discord].
|
||||
|
||||
@ -728,7 +728,7 @@ pub fn clamp(
|
||||
///
|
||||
/// ```example
|
||||
/// #calc.min(1, -3, -5, 20, 3, 6) \
|
||||
/// #calc.min("typst", "in", "beta")
|
||||
/// #calc.min("typst", "is", "cool")
|
||||
/// ```
|
||||
#[func(title = "Minimum")]
|
||||
pub fn min(
|
||||
@ -746,7 +746,7 @@ pub fn min(
|
||||
///
|
||||
/// ```example
|
||||
/// #calc.max(1, -3, -5, 20, 3, 6) \
|
||||
/// #calc.max("typst", "in", "beta")
|
||||
/// #calc.max("typst", "is", "cool")
|
||||
/// ```
|
||||
#[func(title = "Maximum")]
|
||||
pub fn max(
|
||||
|
||||
@ -452,7 +452,7 @@ pub struct TextElem {
|
||||
/// If you set this to `rtl` and experience bugs or in some way bad looking
|
||||
/// output, please do get in touch with us through the
|
||||
/// [contact form](https://typst.app/contact) or our
|
||||
/// [Discord server]($community/#discord)!
|
||||
/// [Discord server](https://discord.gg/2uDybryKPe)!
|
||||
///
|
||||
/// ```example
|
||||
/// #set text(dir: rtl)
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
---
|
||||
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 an 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.
|
||||
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
|
||||
|
||||
## Beta test
|
||||
We are starting a public beta test of our product on March 21st, 2023. The Typst
|
||||
compiler is still under active development and breaking changes can occur at any
|
||||
point. The compiler is developed in the open on
|
||||
[GitHub](https://github.com/typst/typst).
|
||||
|
||||
We will update the members of our Discord server and our social media followers
|
||||
when new features become available. We'll also update you on the development
|
||||
progress of large features.
|
||||
|
||||
## How to support Typst { #support-typst }
|
||||
If you want to support Typst, there are multiple ways to do that! You can
|
||||
[contribute to the code](https://github.com/typst/typst) or
|
||||
[translate the strings in Typst](https://github.com/search?q=repo%3Atypst%2Ftypst+impl+LocalName+for&type=code)
|
||||
to your native language if it's not supported yet. You can also help us by
|
||||
[sponsoring us!](https://github.com/sponsors/typst) Multiple recurring
|
||||
sponsorship tiers are available and all of them come with a set of goodies.
|
||||
No matter how you contribute, thank you for your support!
|
||||
|
||||
## Community Rules { #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 behaviour. 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! { #see-you }
|
||||
Thanks again for learning more about Typst. We would be delighted to meet you on
|
||||
our [Discord server](https://discord.gg/2uDybryKPe)!
|
||||
113
docs/roadmap.md
113
docs/roadmap.md
@ -1,113 +0,0 @@
|
||||
---
|
||||
description: What we have planned for Typst.
|
||||
---
|
||||
|
||||
# Roadmap
|
||||
This page lists planned features for the Typst language, compiler, library and
|
||||
web app. Since priorities and development realities change, this roadmap is not
|
||||
set in stone. Features that are listed here will not necessarily be implemented
|
||||
and features that will be implemented might be missing here. As for bug fixes,
|
||||
this roadmap will only list larger, more fundamental ones.
|
||||
|
||||
Are you missing something on the roadmap? Typst relies on your feedback as a
|
||||
user to plan for and prioritize new features. Get started by filing a new issue
|
||||
on [GitHub](https://github.com/typst/typst/issues) or discuss your feature
|
||||
request with the [community].
|
||||
|
||||
## Language and Compiler
|
||||
- **Structure and Styling**
|
||||
- Support for freezing content, so that e.g. numbers in it remain the same
|
||||
if it appears multiple times
|
||||
- Support for revoking style rules
|
||||
- Ancestry selectors (e.g., within)
|
||||
- Possibly a capability system, e.g. to make your own element referenceable
|
||||
- **Layout**
|
||||
- Advanced floating layout
|
||||
- Rework layout engine to a more flexible model that has first-class support
|
||||
for both "normal" text layout and more canvas-like layout
|
||||
- Unified layout primitives across normal content and math
|
||||
- Named alignment to synchronize alignment across different layout hierarchies
|
||||
- Chained layout regions
|
||||
- Page adjustment from within flow
|
||||
- Advanced page break optimization
|
||||
- Grid-based typesetting
|
||||
- Layout with collision
|
||||
- **Export**
|
||||
- HTML export
|
||||
- EPUB export
|
||||
- Tagged PDF for Accessibility
|
||||
- PDF/A and PDF/X support
|
||||
- **Text and Fonts**
|
||||
- Font fallback warnings
|
||||
- Bold, italic, and smallcaps synthesis
|
||||
- Variable fonts support
|
||||
- Ruby and Warichu
|
||||
- Kashida justification
|
||||
- **Scripting**
|
||||
- Custom types (that work with set and show rules)
|
||||
- Function hoisting if possible
|
||||
- Doc comments
|
||||
- Type hints
|
||||
- **Visualization**
|
||||
- Arrows
|
||||
- Better path drawing
|
||||
- Color management
|
||||
- **Tooling**
|
||||
- Autoformatter
|
||||
- Linter
|
||||
- Documentation generator
|
||||
- **Development**
|
||||
- Benchmarking
|
||||
- Better contributor documentation
|
||||
|
||||
## Library
|
||||
- **Customization**
|
||||
- Richer built-in outline customization
|
||||
- **Numbering**
|
||||
- Relative counters, e.g. for figure numbering per section
|
||||
- Improve equation numbering
|
||||
- Fix issues with numbering patterns
|
||||
- Enum continuation
|
||||
- **Layout**
|
||||
- Balanced columns
|
||||
- Drop caps
|
||||
- End notes, maybe margin notes
|
||||
- **Math**
|
||||
- Fix syntactic quirks
|
||||
- Fix font handling
|
||||
- Provide more primitives
|
||||
- Big fractions
|
||||
- **Other**
|
||||
- Plotting
|
||||
|
||||
## Web App
|
||||
- **Editing**
|
||||
- Smarter & more action buttons
|
||||
- Inline documentation
|
||||
- Preview autocomplete entry
|
||||
- Color Picker
|
||||
- Symbol picker
|
||||
- Basic, built-in image editor (cropping, etc.)
|
||||
- GUI inspector for editing function calls
|
||||
- Cursor in preview
|
||||
- **Writing**
|
||||
- Word count
|
||||
- Structure view
|
||||
- Text completion by LLM
|
||||
- **Collaboration**
|
||||
- Change tracking
|
||||
- Version history
|
||||
- **Project management**
|
||||
- Drag-and-drop for projects
|
||||
- Template generation by LLM
|
||||
- **Settings**
|
||||
- Keyboard shortcuts configuration
|
||||
- Better project settings
|
||||
- Avatar Cropping
|
||||
- **Other**
|
||||
- Offline PWA
|
||||
- Single sign-on
|
||||
- Two-Factor Authentication
|
||||
- Advanced search in projects
|
||||
- Private packages in teams
|
||||
- Mobile improvements
|
||||
@ -91,8 +91,6 @@ pub fn provide(resolver: &dyn Resolver) -> Vec<PageModel> {
|
||||
guide_pages(resolver),
|
||||
packages_page(resolver),
|
||||
md_page(resolver, base, load!("changelog.md")),
|
||||
md_page(resolver, base, load!("roadmap.md")),
|
||||
md_page(resolver, base, load!("community.md")),
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
@ -46,7 +46,6 @@ fn resolve_known(head: &str, base: &str) -> Option<String> {
|
||||
"$context" => format!("{base}reference/context"),
|
||||
"$guides" => format!("{base}guides"),
|
||||
"$changelog" => format!("{base}changelog"),
|
||||
"$community" => format!("{base}community"),
|
||||
"$universe" => "https://typst.app/universe".into(),
|
||||
_ => return None,
|
||||
})
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user