Skip to content

Commit 9686d1c

Browse files
kgrytekgryte
committed
Add support for specifying resource directory
1 parent 4c0d5fe commit 9686d1c

1 file changed

Lines changed: 20 additions & 7 deletions

File tree

‎tools/make/lib/docs/eqns.mk‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ GIT_COMMIT_EQUATIONS ?= $(GIT_COMMIT) -m $(GIT_COMMIT_MESSAGE_EQUATIONS)
2222
# Define the command to commit staged files after inserting resource URLs:
2323
GIT_COMMIT_SRC_URLS ?= $(GIT_COMMIT) -m $(GIT_COMMIT_MESSAGE_SRC_URLS)
2424

25+
# Define the path relative to a processed Markdown file for storing equation resources:
26+
EQUATION_RESOURCES_PATH ?= './docs/img/'
27+
2528
# Define the path to the [remark][1] executable.
2629
#
2730
# To install remark:
@@ -37,10 +40,20 @@ REMARK_IGNORE ?= $(CONFIG_DIR)/.remarkignore
3740
# Define the path to the local remark plugins directory:
3841
REMARK_LOCAL_PLUGINS_DIR ?= $(TOOLS_DIR)/remark/plugins
3942

40-
# Define paths to local plugins:
43+
# Define the path to a plugin which processes Markdown equation comments:
4144
REMARK_HTML_EQUATIONS_PLUGIN ?= $(REMARK_LOCAL_PLUGINS_DIR)/remark-html-equations
45+
REMARK_HTML_EQUATIONS_PLUGIN_SETTINGS ?=
46+
REMARK_HTML_EQUATIONS_PLUGIN_FLAGS ?= '--use '"'""$(REMARK_HTML_EQUATIONS_PLUGIN)$(REMARK_HTML_EQUATIONS_PLUGIN_SETTINGS)""'"
47+
48+
# Define the path to a plugin which creates SVG equations from Markdown equation comments:
4249
REMARK_SVG_EQUATIONS_PLUGIN ?= $(REMARK_LOCAL_PLUGINS_DIR)/remark-svg-equations
50+
REMARK_SVG_EQUATIONS_PLUGIN_SETTINGS ?= '="dir":''"'"$(EQUATION_RESOURCES_PATH)"'"'
51+
REMARK_SVG_EQUATIONS_PLUGIN_FLAGS ?= '--use '"'""$(REMARK_SVG_EQUATIONS_PLUGIN)$(REMARK_SVG_EQUATIONS_PLUGIN_SETTINGS)""'"
52+
53+
# Define the path to a plugin which inserts resource URLs into Markdown HTML equation elements:
4354
REMARK_EQUATION_SRC_URLS_PLUGIN ?= $(REMARK_LOCAL_PLUGINS_DIR)/remark-html-equation-src-urls
55+
REMARK_EQUATION_SRC_URLS_PLUGIN_SETTINGS ?= '="dir":''"'"$(EQUATION_RESOURCES_PATH)"'"'
56+
REMARK_EQUATION_SRC_URLS_PLUGIN_FLAGS ?= '--use '"'""$(REMARK_EQUATION_SRC_URLS_PLUGIN)$(REMARK_EQUATION_SRC_URLS_PLUGIN_SETTINGS)""'"
4457

4558
# Define Markdown extensions:
4659
REMARK_EXT ?= md
@@ -63,7 +76,7 @@ REMARK_OUTPUT_FLAG ?= --output
6376
markdown-html-equations: $(NODE_MODULES)
6477
$(REMARK) $(MARKDOWN_FILES) \
6578
$(REMARK_FLAGS) \
66-
--use $(REMARK_HTML_EQUATIONS_PLUGIN) \
79+
$(REMARK_HTML_EQUATIONS_PLUGIN_FLAGS) \
6780
$(REMARK_OUTPUT_FLAG)
6881

6982
.PHONY: markdown-html-equations
@@ -76,7 +89,7 @@ markdown-html-equations: $(NODE_MODULES)
7689
markdown-svg-equations: $(NODE_MODULES)
7790
$(REMARK) $(MARKDOWN_FILES) \
7891
$(REMARK_FLAGS) \
79-
--use $(REMARK_SVG_EQUATIONS_PLUGIN)
92+
$(REMARK_SVG_EQUATIONS_PLUGIN_FLAGS)
8093

8194
.PHONY: markdown-svg-equations
8295

@@ -88,7 +101,7 @@ markdown-svg-equations: $(NODE_MODULES)
88101
markdown-equation-src-urls: $(NODE_MODULES)
89102
$(REMARK) $(MARKDOWN_FILES) \
90103
$(REMARK_FLAGS) \
91-
--use $(REMARK_EQUATION_SRC_URLS_PLUGIN) \
104+
$(REMARK_EQUATION_SRC_URLS_PLUGIN_FLAGS) \
92105
$(REMARK_OUTPUT_FLAG)
93106

94107
.PHONY: markdown-equation-src-urls
@@ -107,14 +120,14 @@ markdown-equation-src-urls: $(NODE_MODULES)
107120
markdown-equations: $(NODE_MODULES)
108121
$(REMARK) $(MARKDOWN_FILES) \
109122
$(REMARK_FLAGS) \
110-
--use $(REMARK_HTML_EQUATIONS_PLUGIN) \
111-
--use $(REMARK_SVG_EQUATIONS_PLUGIN) \
123+
$(REMARK_HTML_EQUATIONS_PLUGIN_FLAGS) \
124+
$(REMARK_SVG_EQUATIONS_PLUGIN_FLAGS) \
112125
$(REMARK_OUTPUT_FLAG) && \
113126
$(GIT_ADD) && \
114127
$(GIT_COMMIT_EQUATIONS) && \
115128
$(REMARK) $(MARKDOWN_FILES) \
116129
$(REMARK_FLAGS) \
117-
--use $(REMARK_EQUATION_SRC_URLS_PLUGIN) \
130+
$(REMARK_EQUATION_SRC_URLS_PLUGIN_FLAGS) \
118131
$(REMARK_OUTPUT_FLAG) && \
119132
$(GIT_ADD) && \
120133
$(GIT_COMMIT_SRC_URLS)

0 commit comments

Comments
 (0)