highmark-markdown 0.0.247 → 0.0.249
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 +53 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,17 +1,68 @@
|
|
|
1
1
|
# Highmark Markdown
|
|
2
2
|
|
|
3
|
-
Highmark's Markdown.
|
|
3
|
+
Highmark's Markdown and Markdown Style languages.
|
|
4
|
+
|
|
5
|
+
This package includes the lexical entries, BNF, lexers and parsers for both the Markdown and Markdown Style languages.
|
|
6
|
+
Those familiar with Markdown will find that the Markdown implementation here to be mostly familiar.
|
|
7
|
+
On the other hand, the Markdown Style language is entirely new and is most akin to CSS.
|
|
8
|
+
|
|
9
|
+
### Contents
|
|
10
|
+
|
|
11
|
+
- [Introduction](#introduction)
|
|
12
|
+
- [Installation](#installation)
|
|
13
|
+
- [Example](#example)
|
|
14
|
+
- [Building](#buidling)
|
|
15
|
+
- [Contact](#contact)
|
|
16
|
+
|
|
17
|
+
## Introduction
|
|
18
|
+
|
|
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.
|
|
21
|
+
|
|
22
|
+
- [Highmark-CLI](https://github.com/djalbat/highmark-cli) Highmark's CLI tool.
|
|
23
|
+
- [Highmark Yapp](https://github.com/djalbat/highmark-yapp) Highmark with Yapp listings.
|
|
24
|
+
- [Highmark Fonts](https://github.com/djalbat/highmark-fonts) Computer Modern fonts for Highmark.
|
|
25
|
+
- [Highmark Client](https://github.com/djalbat/highmark-client) Highmark's bundled client for viewing HTML.
|
|
26
|
+
- [Highmark Markdown](https://github.com/djalbat/highmark-markdown) Highmark's Markdown and Markdown Style languages.
|
|
27
|
+
|
|
28
|
+
Only the CLI tool is needed by end users.
|
|
29
|
+
All of the other packages are likely only of interest to prospective developers.
|
|
4
30
|
|
|
5
31
|
## Installation
|
|
6
32
|
|
|
7
33
|
If you would like to contribute or would simply like to have a look at the code, you can clone the repository with [Git](https://git-scm.com/)...
|
|
8
34
|
|
|
9
|
-
git clone https://github.com/djalbat/highmark-
|
|
35
|
+
git clone https://github.com/djalbat/highmark-client.git
|
|
10
36
|
|
|
11
37
|
...and then install the dependencies with [npm](https://www.npmjs.com/) from within the project's root directory:
|
|
12
38
|
|
|
13
39
|
npm install
|
|
14
40
|
|
|
41
|
+
## Example
|
|
42
|
+
|
|
43
|
+
There is a small development server that can be run from within the project's directory with the following command:
|
|
44
|
+
|
|
45
|
+
npm start
|
|
46
|
+
|
|
47
|
+
The example will then be available at the following URL:
|
|
48
|
+
|
|
49
|
+
http://localhost:8888
|
|
50
|
+
|
|
51
|
+
The source for the example can be found in the `src/example.js` file and corresponding`src/example` folder. You are encouraged to try the example whilst reading what follows. You can rebuild it on the fly with the following command:
|
|
52
|
+
|
|
53
|
+
npm run watch-debug
|
|
54
|
+
|
|
55
|
+
The development server will reload the page whenever you make changes.
|
|
56
|
+
|
|
57
|
+
One last thing to bear in mind is that this package is included by way of a relative rather than a package import. If you are importing it into your own application, however, you should use the standard package import.
|
|
58
|
+
|
|
59
|
+
## Building
|
|
60
|
+
|
|
61
|
+
Automation is done with [npm scripts](https://docs.npmjs.com/misc/scripts), have a look at the `package.json` file. The pertinent commands are:
|
|
62
|
+
|
|
63
|
+
npm run build-debug
|
|
64
|
+
npm run watch-debug
|
|
65
|
+
|
|
15
66
|
## Contact
|
|
16
67
|
|
|
17
68
|
* james.smith@djalbat.com
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "highmark-markdown",
|
|
3
3
|
"author": "James Smith",
|
|
4
|
-
"version": "0.0.
|
|
4
|
+
"version": "0.0.249",
|
|
5
5
|
"license": "MIT, Anti-996",
|
|
6
6
|
"homepage": "https://github.com/djalbat/highmark-markdown",
|
|
7
|
-
"description": "Highmark's Markdown.",
|
|
7
|
+
"description": "Highmark's Markdown and Markdown Style languages.",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
10
|
"url": "https://github.com/djalbat/highmark-markdown"
|