Skip to content

Commit

Permalink
README&issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
sitandr committed Nov 5, 2023
1 parent 52c1b0f commit 82bc97c
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/new-snippet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: New snippet
about: Add new snippet to the book
title: "[Snippet(s) name here]"
labels: new snippet
assignees: sitandr

---

**Location**: [where in the book should be snippet located]

**Importance**: [why should it be in the book]

**Snippet**:
```typ
[The code there]
```

<!-- If possible, attach rendered image from snippet, plese. -->
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# 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!

0 comments on commit 82bc97c

Please sign in to comment.