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
Enables CSScolors to be used by their names within a Typst document.
4
+
Allows CSS/SVG named colors to be used directly in a Typst document.
5
5
6
6
## Template adaptation checklist
7
7
@@ -27,14 +27,12 @@ Enables CSS colors to be used by their names within a Typst document.
27
27
28
28
## Getting Started
29
29
30
-
These instructions will get you a copy of the project up and running on the typst web app. Perhaps a short code example on importing the package and a very simple teaser usage.
30
+
These instructions will get you a copy of the project up and running on the typst web app.
31
31
32
32
```typ
33
33
#import "@preview/css-colors:0.1.0": *
34
34
35
35
Normal text may be #text(fill: css("crimson"))[colored so.]
@@ -44,42 +42,79 @@ Normal text may be #text(fill: css("crimson"))[colored so.]
44
42
45
43
## Installation
46
44
47
-
Set up your development environment by following these steps:
45
+
Follow these steps to set up your development environment and prepare for contributing to the project:
48
46
49
47
1.**Typst**
50
-
Install Typst (version 0.13.0 or higher) using the [official installation instructions](https://github.com/typst/typst?tab=readme-ov-file#installation).
51
-
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.
52
49
53
50
1.**Just**
54
-
Install [Just](https://just.systems/man/en/introduction.html)using a package manager or by downloading a pre-built binary. For more information, refer to the [available packages](https://just.systems/man/en/packages.html).
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.
55
52
56
53
1.**tytanic**
57
-
Install [tytanic](https://tingerrr.github.io/tytanic/index.html) by following the [quickstart installation guide](https://tingerrr.github.io/tytanic/quickstart/install.html).
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.
58
55
59
56
1.**Clone the Repository**
60
-
Clone the project repository to your local machine:
57
+
Download the project's source code by cloning the repository to your local machine:
Once you've completed these steps, your development environment will be ready.
67
64
65
+
### Next Steps
66
+
67
+
The `css-colors` package source code is located at:
68
+
69
+
```plaintext
70
+
src/css-colors.typ
71
+
```
72
+
73
+
This is where you will make any necessary changes to the module.
74
+
75
+
### Running Tests
76
+
77
+
To test the functionality of the module locally, run the predefined test cases using the following command:
78
+
79
+
```bash
80
+
just test
81
+
```
82
+
83
+
Ensure that all tests pass before submitting any changes to maintain the project's integrity.
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:
86
+
87
+
```bash
88
+
just install-preview
89
+
```
90
+
91
+
Once installed, you can import the module into your typst file using the following statement:
92
+
93
+
```typ
94
+
#import "@preview/css-colors:0.1.0": *
95
+
```
96
+
97
+
This setup allows you to experiment with the module in a typst file before finalizing your changes.
98
+
68
99
## Usage
69
100
70
-
A more in-depth description of usage. Any template arguments? A complicated example that showcases most if not all of the functions the package provides? This is also an excellent place to signpost the manual.
101
+
Here are some examples demonstrating how to use the css-colors module:
0 commit comments