You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ Allows CSS/SVG named colors to be used directly in a Typst document.
5
5
6
6
## Template adaptation checklist
7
7
8
-
-[] Fill out `README.md`
8
+
-[x] Fill out `README.md`
9
9
- Change the `my-package` package name, including code snippets
10
10
- Check section contents and/or delete sections that don't apply
11
11
-[x] Check and/or replace `LICENSE` by something that suits your needs
@@ -44,16 +44,16 @@ Normal text may be #text(fill: css("crimson"))[colored so.]
44
44
45
45
Follow these steps to set up your development environment and prepare for contributing to the project:
46
46
47
-
1.**Typst**
47
+
1.**Typst:**
48
48
Install Typst (version 0.13.0 or higher) using the [official installation instructions](https://github.com/typst/typst?tab=readme-ov-file#installation). Typst is required to work with the core functionality of the project.
49
49
50
-
1.**Just**
50
+
1.**Just:**
51
51
Install [Just](https://just.systems/man/en/introduction.html), a handy command runner for executing predefined tasks. You can install it using a package manager or by downloading a pre-built binary. Refer to the [available packages](https://just.systems/man/en/packages.html) for installation instructions specific to your operating system.
52
52
53
-
1.**tytanic**
53
+
1.**tytanic:**
54
54
Install [tytanic](https://tingerrr.github.io/tytanic/index.html), a library essential for testing and working with Typst projects. Use the [quickstart installation guide](https://tingerrr.github.io/tytanic/quickstart/install.html) to get it up and running.
55
55
56
-
1.**Clone the Repository**
56
+
1.**Clone the Repository:**
57
57
Download the project's source code by cloning the repository to your local machine:
58
58
59
59
```bash
@@ -82,7 +82,7 @@ just test
82
82
83
83
Ensure that all tests pass before submitting any changes to maintain the project's integrity.
84
84
85
-
If you want to test the module with a typst file, you can install the css-colors package locally in the preview location by running:
85
+
If you want to test the module with a typst file, you can install the `css-colors` package locally in the `preview` location by running:
86
86
87
87
```bash
88
88
just install-preview
@@ -98,12 +98,14 @@ This setup allows you to experiment with the module in a typst file before final
98
98
99
99
## Usage
100
100
101
-
Here are some examples demonstrating how to use the css-colors module:
101
+
Here are some examples demonstrating how to use the `css-colors` module:
0 commit comments