1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
#/
# @license Apache-2.0
#
# Copyright (c) 2017 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/
# VARIABLES #
# Define the command to commit staged files after processing Markdown equations:
GIT_COMMIT_EQUATIONS ?= $(GIT_COMMIT) -m 'Process Markdown equations'
# Define the command to commit staged files after inserting resource URLs:
GIT_COMMIT_EQUATIONS_SRC_URLS ?= $(GIT_COMMIT) -m 'Insert src urls into equation elements'
# Define the path relative to a processed Markdown file for storing equation resources:
EQUATION_RESOURCES_PATH ?= ./docs/img/
# Define the path to the remark configuration file:
REMARK_EQUATIONS_CONF ?= $(CONFIG_DIR)/remark/.remarkrc.js
# Define the path to the remark ignore file:
# REMARK_EQUATIONS_IGNORE ?= $(CONFIG_DIR)/remark/.remarkignore FIXME
REMARK_EQUATIONS_IGNORE ?= $(ROOT_DIR)/.remarkignore
# Define the path to a plugin which processes Markdown equation comments:
REMARK_IMG_EQUATIONS_PLUGIN ?= $(TOOLS_PKGS_DIR)/remark/plugins/remark-img-equations
REMARK_IMG_EQUATIONS_PLUGIN_SETTINGS ?=
REMARK_IMG_EQUATIONS_PLUGIN_FLAGS ?= --use $(REMARK_IMG_EQUATIONS_PLUGIN)=$(REMARK_IMG_EQUATIONS_PLUGIN_SETTINGS)
# Define the path to a plugin which creates SVG equation files from Markdown equation comments:
REMARK_SVG_EQUATIONS_PLUGIN ?= $(TOOLS_PKGS_DIR)/remark/plugins/remark-svg-equations-to-file
REMARK_SVG_EQUATIONS_PLUGIN_SETTINGS ?= '"'dir'"':'"'$(EQUATION_RESOURCES_PATH)'"'
REMARK_SVG_EQUATIONS_PLUGIN_FLAGS ?= --use $(REMARK_SVG_EQUATIONS_PLUGIN)=$(REMARK_SVG_EQUATIONS_PLUGIN_SETTINGS)
# Define the path to a plugin which inserts resource URLs into Markdown image equation elements:
REMARK_IMG_EQUATIONS_SRC_URLS_PLUGIN ?= $(TOOLS_PKGS_DIR)/remark/plugins/remark-img-equations-src-urls
REMARK_IMG_EQUATIONS_SRC_URLS_PLUGIN_SETTINGS ?= '"'dir'"':'"'$(EQUATION_RESOURCES_PATH)'"'
REMARK_IMG_EQUATIONS_SRC_URLS_PLUGIN_FLAGS ?= --use $(REMARK_IMG_EQUATIONS_SRC_URLS_PLUGIN)=$(REMARK_IMG_EQUATIONS_SRC_URLS_PLUGIN_SETTINGS)
# Define command-line options when invoking the remark executable:
REMARK_EQUATIONS_FLAGS ?= \
--ext $(MARKDOWN_FILENAME_EXT) \
--rc-path $(REMARK_EQUATIONS_CONF) \
--ignore-path $(REMARK_EQUATIONS_IGNORE)
# Define the remark output option:
REMARK_EQUATIONS_OUTPUT_FLAG ?= --output
# RULES #
#/
# Processes Markdown files containing Markdown equation elements.
#
# ## Notes
#
# - Processing happens as follows:
#
# 1. Files containing equation comments are transformed to include equation elements.
# 2. SVG files are generated for each equation.
# 3. Processed files are committed to source control.
# 4. Resource URLs are inserted into image equation elements.
# 5. Processed files are committed to source control.
#
# - This rule is useful when wanting to glob for Markdown files (e.g., process all Markdown files for a particular package).
#
#
# @param {string} [MARKDOWN_FILTER] - file path pattern (e.g., `.*/math/base/special/.*`)
# @param {string} [MARKDOWN_PATTERN] - filename pattern (e.g., `*.md`)
#
# @example
# make markdown-equations
#
# @example
# make markdown-equations MARKDOWN_PATTERN='README.md' MARKDOWN_FILTER='.*/math/base/special/.*'
#/
markdown-equations: $(NODE_MODULES) assert-clean-working-directory
$(QUIET) NODE_PATH="$(NODE_PATH)" $(REMARK) $(MARKDOWN_FILES) \
$(REMARK_EQUATIONS_FLAGS) \
$(REMARK_IMG_EQUATIONS_PLUGIN_FLAGS) \
$(REMARK_SVG_EQUATIONS_PLUGIN_FLAGS) \
$(REMARK_EQUATIONS_OUTPUT_FLAG) && \
$(GIT_ADD) -A && $(GIT_COMMIT_EQUATIONS) && \
NODE_PATH="$(NODE_PATH)" $(REMARK) $(MARKDOWN_FILES) \
$(REMARK_EQUATIONS_FLAGS) \
$(REMARK_IMG_EQUATIONS_SRC_URLS_PLUGIN_FLAGS) \
$(REMARK_EQUATIONS_OUTPUT_FLAG) && \
$(GIT_ADD) -A && $(GIT_COMMIT_EQUATIONS_SRC_URLS)
.PHONY: markdown-equations
#/
# Transforms Markdown files containing equation comment markup to include image equation elements.
#
# ## Notes
#
# - This rule is useful when wanting to glob for Markdown files (e.g., process all Markdown files for a particular package).
#
# @param {string} [MARKDOWN_FILTER] - file path pattern (e.g., `.*/math/base/special/.*`)
# @param {string} [MARKDOWN_PATTERN] - filename pattern (e.g., `*.md`)
#
# @example
# make markdown-img-equations
#
# @example
# make markdown-img-equations MARKDOWN_PATTERN='README.md' MARKDOWN_FILTER='.*/math/base/special/.*'
#/
markdown-img-equations: $(NODE_MODULES)
$(QUIET) $(FIND_MARKDOWN_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ""; \
echo "Processing file: $$file"; \
NODE_PATH="$(NODE_PATH)" \
$(NODE) "$(REMARK)" \
$$file \
$(REMARK_EQUATIONS_FLAGS) \
$(REMARK_IMG_EQUATIONS_PLUGIN_FLAGS) \
$(REMARK_EQUATIONS_OUTPUT_FLAG) || exit 1; \
done
.PHONY: markdown-img-equations
#/
# Transforms a specified list of Markdown files containing equation comment markup to include image equation elements.
#
# ## Notes
#
# - This rule is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
#
# @param {string} FILES - list of files
#
# @example
# make markdown-img-equations-files FILES='/foo/foo.md /foo/bar.md'
#/
markdown-img-equations-files: $(NODE_MODULES)
$(QUIET) for file in $(FILES); do \
echo ""; \
echo "Processing file: $$file"; \
NODE_PATH="$(NODE_PATH)" \
$(NODE) "$(REMARK)" \
$$file \
$(REMARK_EQUATIONS_FLAGS) \
$(REMARK_IMG_EQUATIONS_PLUGIN_FLAGS) \
$(REMARK_EQUATIONS_OUTPUT_FLAG) || exit 1; \
done
.PHONY: markdown-img-equations-files
#/
# Generates SVG equation files from Markdown equation comments.
#
# @param {string} [MARKDOWN_FILTER] - file path pattern (e.g., `.*/math/base/special/.*`)
# @param {string} [MARKDOWN_PATTERN] - filename pattern (e.g., `*.md`)
#
# @example
# make markdown-svg-equations
#
# @example
# make markdown-svg-equations MARKDOWN_PATTERN='README.md' MARKDOWN_FILTER='.*/math/base/special/.*'
markdown-svg-equations: $(NODE_MODULES)
$(QUIET) $(FIND_MARKDOWN_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ""; \
echo "Processing file: $$file"; \
NODE_PATH="$(NODE_PATH)" \
$(NODE) "$(REMARK)" \
$$file \
$(REMARK_EQUATIONS_FLAGS) \
$(REMARK_SVG_EQUATIONS_PLUGIN_FLAGS) || exit 1; \
done
.PHONY: markdown-svg-equations
#/
# Generates SVG equation files from Markdown equation comments for a specified list of files.
#
# ## Notes
#
# - This rule is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
#
# @param {string} FILES - list of files
#
# @example
# make markdown-svg-equations-files FILES='/foo/foo.md /foo/bar.md'
markdown-svg-equations-files: $(NODE_MODULES)
$(QUIET) for file in $(FILES); do \
echo ""; \
echo "Processing file: $$file"; \
NODE_PATH="$(NODE_PATH)" \
$(NODE) "$(REMARK)" \
$$file \
$(REMARK_EQUATIONS_FLAGS) \
$(REMARK_SVG_EQUATIONS_PLUGIN_FLAGS) || exit 1; \
done
.PHONY: markdown-svg-equations-files
#/
# Inserts resource URLs into Markdown image equation elements.
#
# ## Notes
#
# - This rule is useful when wanting to glob for Markdown files (e.g., process all Markdown files for a particular package).
# - This recipe assumes that image SVG equation files already exist and have been committed to source control.
#
# @param {string} [MARKDOWN_FILTER] - file path pattern (e.g., `.*/math/base/special/.*`)
# @param {string} [MARKDOWN_PATTERN] - filename pattern (e.g., `*.md`)
#
# @example
# make markdown-img-equations-src-urls
#
# @example
# make markdown-img-equations-src-urls MARKDOWN_PATTERN='README.md' MARKDOWN_FILTER='.*/math/base/special/.*'
markdown-img-equations-src-urls: $(NODE_MODULES)
$(QUIET) $(FIND_MARKDOWN_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ""; \
echo "Processing file: $$file"; \
NODE_PATH="$(NODE_PATH)" \
$(NODE) "$(REMARK)" \
$$file \
$(REMARK_EQUATIONS_FLAGS) \
$(REMARK_IMG_EQUATIONS_SRC_URLS_PLUGIN_FLAGS) \
$(REMARK_EQUATIONS_OUTPUT_FLAG) || exit 1; \
done
.PHONY: markdown-img-equations-src-urls
#/
# Inserts resource URLs into Markdown image equation elements for a specified list of files.
#
# ## Notes
#
# - This rule is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
# - This recipe assumes that image SVG equation files already exist and have been committed to source control.
#
# @param {string} FILES - list of files
#
# @example
# make markdown-img-equations-src-urls-files FILES='/foo/foo.md /foo/bar.md'
markdown-img-equations-src-urls-files: $(NODE_MODULES)
$(QUIET) for file in $(FILES); do \
echo ""; \
echo "Processing file: $$file"; \
NODE_PATH="$(NODE_PATH)" \
$(NODE) "$(REMARK)" \
$$file \
$(REMARK_EQUATIONS_FLAGS) \
$(REMARK_IMG_EQUATIONS_SRC_URLS_PLUGIN_FLAGS) \
$(REMARK_EQUATIONS_OUTPUT_FLAG) || exit 1; \
done
.PHONY: markdown-img-equations-src-urls-files
#/
# Removes SVG equation files.
#
# @param {string} [SVG_EQUATIONS_FILTER] - file path pattern (e.g., `.*/math/base/special/.*`)
# @param {string} [SVG_EQUATIONS_PATTERN] - filename pattern (e.g., `equation*.svg`)
#
# @example
# make clean-markdown-svg-equations
#
# @example
# make clean-markdown-svg-equations SVG_EQUATIONS_PATTERN='equations*.svg' SVG_EQUATIONS_FILTER='.*/math/base/special/.*'
#/
clean-markdown-svg-equations:
$(QUIET) $(DELETE) -f $(SVG_EQUATION_FILES)
.PHONY: clean-markdown-svg-equations
|
