Giter Club home page Giter Club logo

typst-examples-book's Introduction

Typst Examples Book

See the book there: https://sitandr.github.io/typst-examples-book/book/

Highlight & rendering

Currently powered by https://github.com/sitandr/mdbook-typst-highlight.

Contributing

If you have a snippet you want to have in a book, feel free to create an issue.

Any PR-s are very welcome!

Generally encouraged:

  • Editing (expanding examples, fixing bad language issues)
  • Selecting any really useful code examples from Discord and Github
  • Ideas (just any ideas how to make the book more useful)

Currently needed:

  • Help with updating state manual to context expressions.
  • Updating examples with possibilities of new Typst versions
  • Some impressive demos

If you think you can do some large work, please DM me in Discord (@sitandr) or mail ([email protected]) to avoid duplication.

Rules

  1. Many snippets are taken from Discord, Github or other places. Without using them that book would much, much more harder to write. However, getting a consent for every snippet will be a total disaster. So, as a general rule, if the snippet is a non-trivial one (one that combines typst function in a smart way), there should be a credit to original author (of course, the credit will be removed if author objects).
  2. In "Typst by Example" section the concepts that are not told yet should be avoided if possible. Although it is okay to use them if they are really intuitive and without them the demonstration would be too dull.
  3. "Typst Snippets" and "Typstonomicon" should not include staff that is already present in official packages. Instead, there should be a link to a package. However it is allowed to use packages as a tool in snippets, if the package using is "secondary" there or the idea of using that package for that task is not obvious.
  4. Giant queries and hack things should go to "Typstonomicon", not "Typst snippets", even if they are super-useful. "Typst snippets" should contain code as clean as possible.

Cleaning cached Typst files

git clean -d -X -i

Make sure to avoid deleting something useful.

typst-examples-book's People

Contributors

sitandr avatar tingerrr avatar leedehai avatar epicericee avatar ydx-2147483647 avatar sebastianjl avatar ntjess avatar orangex4 avatar owiecc avatar tanloong avatar max397574 avatar stormckey avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.