highmark-cli 0.0.208 → 0.0.211
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 +24 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
# Highmark-CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Highmark's CLI tool.
|
|
4
|
+
|
|
5
|
+
This tool enables the creation of HTML from Markdown and Markdown Style documents as well as providing a small server to view the HTML in a browser.
|
|
6
|
+
It can make use of Highmark's client in order to improve the reading experience, otherwise the HTML can be viewed directly.
|
|
7
|
+
|
|
8
|
+
If you are not a developer and just want to install the package for immediate use then see the usage section below.
|
|
4
9
|
|
|
5
10
|
### Contents
|
|
6
11
|
|
|
@@ -11,7 +16,15 @@ Extensible, styleable Markdown.
|
|
|
11
16
|
|
|
12
17
|
## Introduction
|
|
13
18
|
|
|
14
|
-
|
|
19
|
+
Highmark is a document preparation system inspired by [Markdown](https://en.wikipedia.org/wiki/Markdown) and [TeX](https://en.wikipedia.org/wiki/TeX).
|
|
20
|
+
There are several packages in the distribution, of which only the CLI tool is needed by end users.
|
|
21
|
+
All of the other packages are likely only of interest to prospective developers.
|
|
22
|
+
|
|
23
|
+
- [Highmark-CLI](https://github.com/djalbat/highmark-cli) Highmark's CLI tool.
|
|
24
|
+
- [Highmark Yapp](https://github.com/djalbat/highmark-yapp) Highmark with Yapp listings.
|
|
25
|
+
- [Highmark Fonts](https://github.com/djalbat/highmark-fonts) Computer Modern fonts for Highmark.
|
|
26
|
+
- [Highmark Client](https://github.com/djalbat/highmark-clieet) Highmark's client for viewing HTML.
|
|
27
|
+
- [Highmark Markdown](https://github.com/djalbat/highmark-markdown) Highmark's Markdown and Markdown Style languages.
|
|
15
28
|
|
|
16
29
|
## Installation
|
|
17
30
|
|
|
@@ -23,8 +36,17 @@ If you would like to contribute or would simply like to have a look at the code,
|
|
|
23
36
|
|
|
24
37
|
npm install
|
|
25
38
|
|
|
39
|
+
|
|
26
40
|
## Usage
|
|
27
41
|
|
|
42
|
+
The tool should be installed globally:
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
npm install --global highmark-cli@latest
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Dependening on your setup you may need to prepend `sudo` to the above.
|
|
49
|
+
|
|
28
50
|
These are the commands and options:
|
|
29
51
|
|
|
30
52
|
```
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "highmark-cli",
|
|
3
3
|
"author": "James Smith",
|
|
4
|
-
"version": "0.0.
|
|
4
|
+
"version": "0.0.211",
|
|
5
5
|
"license": "MIT, Anti-996",
|
|
6
6
|
"homepage": "https://github.com/djalbat/highmark-cli",
|
|
7
|
-
"description": "
|
|
7
|
+
"description": "Highmark's LIC tool.",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
10
|
"url": "https://github.com/djalbat/highmark-cli"
|