Add MathJax to Doc

li3zhen1 · Oct 22, 2023 · d1bedb3 · d1bedb3
1 parent a4ca999
commit d1bedb3
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 3 deletions.
diff --git a/DocPostprocess.swift b/DocPostprocess.swift
@@ -50,6 +50,19 @@ do {
                                     font-variation-settings: 'wght' 600, 'opsz' 24!important;
                                 }
                             </style>
+                            <script>
+                            MathJax = {
+                            tex: {
+                                inlineMath: [['$', '$'], ['\\(', '\\)']]
+                            },
+                            svg: {
+                                fontCache: 'global'
+                            }
+                            };
+                            </script>
+                            <script type="text/javascript" id="MathJax-script" async
+                            src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js">
+                            </script>
                             """)
 
                     try htmlString.write(toFile: indexPath, atomically: false, encoding: .utf8)

diff --git a/Sources/ForceSimulation/ForceSimulation.docc/Documentation.md b/Sources/ForceSimulation/ForceSimulation.docc/Documentation.md
@@ -21,7 +21,6 @@ The basic concepts of simulations and forces can be found here: [Force simulatio
 * <doc:Creating2DAnd3DSimulations>
 * ``Simulation2D``
 * ``Simulation3D``
-
 * ``Simulation``
 
 ### Creating forces in a simulation

diff --git a/Sources/ForceSimulation/Simulation.swift b/Sources/ForceSimulation/Simulation.swift
@@ -139,7 +139,7 @@ public final class Simulation<NodeID, V> where NodeID: Hashable, V: VectorLike,
     /// A 2D simulation running on `Double` and `simd_double2` types.
     public typealias Simulation2D<NodeID> = Simulation<NodeID, Vector2d> where NodeID: Hashable
 
-    /// A 3D simulation running on `Double` and `simd_double2` types.
+    /// A 3D simulation running on `Double` and `simd_double3` types.
     public typealias Simulation3D<NodeID> = Simulation<NodeID, Vector3d> where NodeID: Hashable
 
 #endif
diff --git a/Sources/ForceSimulation/forces/CenterForce.swift b/Sources/ForceSimulation/forces/CenterForce.swift
@@ -7,7 +7,7 @@
 import NDTree
 
 /// A force that drives nodes towards the center.
-/// Center force is relatively fast, the complexity is `O(n)`,
+/// Center force is relatively fast, the complexity is $O(n)$,
 /// where `n` is the number of nodes.
 /// See [Collide Force - D3](https://d3js.org/d3-force/collide).
 final public class CenterForce<NodeID, V>: ForceLike