begin usage guide & fix workflow

carloskiki · Aug 1, 2024 · df53dcc · df53dcc
1 parent 0028f7c
commit df53dcc
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 2 deletions.
diff --git a/.github/workflows/releases.yml b/.github/workflows/releases.yml
@@ -29,8 +29,9 @@ jobs:
           body: ${{ env.RELEASE_NOTES }}
           files: |
             styles.css
-            font/
+            font
           generate_release_notes: true
+          fail_on_unmatched_files: true
 
 permissions:
   contents: write
diff --git a/site/docs/usage.md b/site/docs/usage.md
@@ -0,0 +1,36 @@
+# Usage
+
+Rendering mathematical equations with `pulldown-latex` obviously begins with using
+the crate in order to generate the `mathml` markup. However, one also needs to include
+the stylesheet and fonts necessary to render the equations correctly and aesthetically.
+
+## Including the Required Files
+
+Files can be included in one of two ways, either by using a CDN or by downloading them
+from the release page and using them locally.
+
+### Using a CDN
+
+In the index.html file of your project, include the following lines:
+
+```html
+<head>
+    <!-- Rest of your HTML head -->
+    <!-- ...................... -->
+
+    <!-- Include the Stylesheet -->
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/carloskiki/pulldown-latex@{version}/styles.min.css">
+    <!-- Include the Fonts -->
+    <link rel="preload" href="https://cdn.jsdelivr.net/gh/carloskiki/pulldown-latex@{version}/font/" as="font" crossorigin="anonymous">
+
+    <!-- Rest of your HTML head -->
+    <!-- ...................... -->
+</head>
+```
+
+Make sure to replace `{version}` with the version of the crate you are using or with `latest` if you want to use the
+latest version available.
+
+### Using Local Files
+
+Download the files from the release page and include them in your project. Then, include the following lines in the
diff --git a/styles.css b/styles.css
@@ -1,6 +1,5 @@
 @namespace m url('http://www.w3.org/1998/Math/MathML');
 
-
 /* Latin Modern Roman has various sizes. We use the generic name
    "Latin Modern Roman" for the local versions and "LMRoman12" for the Web font.
 */