highmark-occam 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,23 +12,8 @@ This package augments the HTML created with Highmark with listings for the follo
|
|
|
12
12
|
* Markdown
|
|
13
13
|
* Markdown Style
|
|
14
14
|
|
|
15
|
-
Additinoally, a pakbage name can be stipulated for Nominal listings and, provided the corresponding custom grammars have been registered, the Nominal listing will be parsed accordingly.
|
|
16
|
-
|
|
17
|
-
```
|
|
18
|
-
\`\`\`nominal:first-order-logic
|
|
19
|
-
Lemma
|
|
20
|
-
Suppose
|
|
21
|
-
[F] |- R :: S
|
|
22
|
-
Then
|
|
23
|
-
∃[G] [G] |- R :: S
|
|
24
|
-
Proof
|
|
25
|
-
[G] is 𝘧𝘳𝘦𝘦 in [G] |- R :: S by FreeMetavariable
|
|
26
|
-
Therefore
|
|
27
|
-
∃[G] [G] |- R :: S by MetaExistentialIntroduction
|
|
28
|
-
\`\`\`
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
The results are listings that are effectively indistinguishable from the pretty printed source in Occam's IDE.
|
|
15
|
+
Additinoally, a pakbage name can be stipulated for Nominal listings and, provided the corresponding custom grammars have been registered, the Nominal listing will be parsed accordingly.
|
|
16
|
+
The results are listings that are effectively indistinguishable from the pretty printed source in Occam's own IDE.
|
|
32
17
|
|
|
33
18
|
### Contents
|
|
34
19
|
|
|
@@ -83,7 +68,7 @@ One last thing to bear in mind is that this package is included by way of a rela
|
|
|
83
68
|
|
|
84
69
|
## Usage
|
|
85
70
|
|
|
86
|
-
To begin with you must render
|
|
71
|
+
To begin with you must render Occam's styles pertaining to its pretty printer:
|
|
87
72
|
|
|
88
73
|
```
|
|
89
74
|
import { renderOccamStyles } from "highmark-occam";
|
|
@@ -93,7 +78,7 @@ renderOccamStyles();
|
|
|
93
78
|
...
|
|
94
79
|
```
|
|
95
80
|
|
|
96
|
-
Next, to create a node from some Markdown content, use the `tokensFromMarkdown()`, `markdownNodeFromTokens()` and `topmostHTMLNodeFromMarkdownNode()` utility functions:
|
|
81
|
+
Next, in order to create a node from some Markdown content, use the `tokensFromMarkdown()`, `markdownNodeFromTokens()` and `topmostHTMLNodeFromMarkdownNode()` utility functions:
|
|
97
82
|
|
|
98
83
|
```
|
|
99
84
|
import { grammarUtilities } from "highmark-occam";
|
package/package.json
CHANGED