Skip to content

Commit 2a2cfa6

Browse files
committed
Bump metalsmith-markdown to 1.3.0
Turns out that changes the output a bit, cool
1 parent a048a08 commit 2a2cfa6

File tree

3 files changed

+43
-33
lines changed

3 files changed

+43
-33
lines changed

docs/index.html

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,13 @@
7070

7171

7272
<ol>
73-
<li><a class="toc-item" href="#why-do-makefiles-exist-">Why do Makefiles exist?</a>
73+
<li><a class="toc-item" href="#why-do-makefiles-exist">Why do Makefiles exist?</a>
7474
</li>
7575

7676
</ol>
7777

7878
<ol>
79-
<li><a class="toc-item" href="#what-alternatives-are-there-to-make-">What alternatives are there to Make?</a>
79+
<li><a class="toc-item" href="#what-alternatives-are-there-to-make">What alternatives are there to Make?</a>
8080
</li>
8181

8282
</ol>
@@ -150,7 +150,7 @@
150150
</ol>
151151

152152
<ol>
153-
<li><a class="toc-item" href="#-wildcard">% Wildcard</a>
153+
<li><a class="toc-item" href="#-wildcard-1">% Wildcard</a>
154154
</li>
155155

156156
</ol>
@@ -212,7 +212,7 @@
212212

213213

214214
<ol>
215-
<li><a class="toc-item" href="#command-echoing-silencing">Command Echoing/Silencing</a>
215+
<li><a class="toc-item" href="#command-echoingsilencing">Command Echoing/Silencing</a>
216216
</li>
217217

218218
</ol>
@@ -230,7 +230,7 @@
230230
</ol>
231231

232232
<ol>
233-
<li><a class="toc-item" href="#error-handling-with-k-i-and-">Error handling with -k, -i, and -</a>
233+
<li><a class="toc-item" href="#error-handling-with--k--i-and--">Error handling with -k, -i, and -</a>
234234
</li>
235235

236236
</ol>
@@ -310,7 +310,7 @@
310310

311311

312312
<ol>
313-
<li><a class="toc-item" href="#conditional-if-else">Conditional if/else</a>
313+
<li><a class="toc-item" href="#conditional-ifelse">Conditional if/else</a>
314314
</li>
315315

316316
</ol>
@@ -328,7 +328,7 @@
328328
</ol>
329329

330330
<ol>
331-
<li><a class="toc-item" href="#-makeflags-">$(makeflags)</a>
331+
<li><a class="toc-item" href="#makeflags">$(makeflags)</a>
332332
</li>
333333

334334
</ol>
@@ -408,13 +408,13 @@
408408
</ol>
409409

410410
<ol>
411-
<li><a class="toc-item" href="#-phony">.phony</a>
411+
<li><a class="toc-item" href="#phony">.phony</a>
412412
</li>
413413

414414
</ol>
415415

416416
<ol>
417-
<li><a class="toc-item" href="#-delete_on_error">.delete_on_error</a>
417+
<li><a class="toc-item" href="#delete_on_error">.delete_on_error</a>
418418
</li>
419419

420420
</ol>
@@ -439,14 +439,14 @@
439439
<p>If you mostly understand Make, consider checking out the Makefile Cookbook, which has a template for medium sized projects with ample comments about what each part of the Makefile is doing.</p>
440440
<p>Good luck, and I hope you are able to slay the confusing world of Makefiles!</p>
441441
<h1 id="getting-started">Getting Started</h1>
442-
<h2 id="why-do-makefiles-exist-">Why do Makefiles exist?</h2>
442+
<h2 id="why-do-makefiles-exist">Why do Makefiles exist?</h2>
443443
<p>Makefiles are used to help decide which parts of a large program need to be recompiled. In the vast majority of cases, C or C++ files are compiled. Other languages typically have their own tools that serve a similar purpose as Make. It can be used beyond programs too, when you need a series of instructions to run depending on what files have changed. This tutorial will focus on the C/C++ compilation use case.</p>
444444
<p>Here&#39;s an example dependency graph that you might build with Make. If any file&#39;s dependencies changes, then the file will get recompiled:</p>
445445
<div class="center">
446446
<img src="/assets/dependency_graph.png">
447447
</div>
448448

449-
<h2 id="what-alternatives-are-there-to-make-">What alternatives are there to Make?</h2>
449+
<h2 id="what-alternatives-are-there-to-make">What alternatives are there to Make?</h2>
450450
<p>Popular C/C++ alternative build systems are <a href="https://scons.org/">SCons</a>, <a href="https://cmake.org/">CMake</a>, <a href="https://bazel.build/">Bazel</a>, and <a href="https://ninja-build.org/">Ninja</a>. Some code editors like <a href="https://visualstudio.microsoft.com/">Microsoft Visual Studio</a> have their own built in build tools. For Java, there&#39;s <a href="https://ant.apache.org/">Ant</a>, <a href="https://maven.apache.org/what-is-maven.html">Maven</a>, and <a href="https://gradle.org/">Gradle</a>. Other languages like Go and Rust have their own build tools.</p>
451451
<p>Interpreted languages like Python, Ruby, and Javascript don&#39;t require an analogue to Makefiles. The goal of Makefiles is to compile whatever files need to be compiled, based on what files have changed. But when files in interpreted languages change, nothing needs to get recompiled. When the program runs, the most recent version of the file is used.</p>
452452
<h2 id="the-versions-and-types-of-make">The versions and types of Make</h2>
@@ -614,7 +614,7 @@ <h2 id="-wildcard">* Wildcard</h2>
614614
<span class="hljs-section">four: $(wildcard *.o)</span></code></pre>
615615

616616

617-
<h2 id="-wildcard">% Wildcard</h2>
617+
<h2 id="-wildcard-1">% Wildcard</h2>
618618
<p><code>%</code> is really useful, but is somewhat confusing because of the variety of situations it can be used in.</p>
619619
<ul>
620620
<li>When used in &quot;matching&quot; mode, it matches one or more characters in a string. This match is called the stem.</li>
@@ -780,7 +780,7 @@ <h2 id="double-colon-rules">Double-Colon Rules</h2>
780780

781781

782782
<h1 id="commands-and-execution">Commands and execution</h1>
783-
<h2 id="command-echoing-silencing">Command Echoing/Silencing</h2>
783+
<h2 id="command-echoingsilencing">Command Echoing/Silencing</h2>
784784
<!-- (Section 5.1) -->
785785
<p>Add an <code>@</code> before a command to stop it from being printed<br>You can also run make with <code>-s</code> to add an <code>@</code> before each line </p>
786786
<pre><code class="hljs makefile"><span class="hljs-section">all: </span>
@@ -810,7 +810,7 @@ <h2 id="default-shell">Default Shell</h2>
810810
<span class="hljs-section">cool:</span>
811811
echo <span class="hljs-string">"Hello from bash"</span></code></pre>
812812

813-
<h2 id="error-handling-with-k-i-and-">Error handling with <code>-k</code>, <code>-i</code>, and <code>-</code></h2>
813+
<h2 id="error-handling-with--k--i-and--">Error handling with <code>-k</code>, <code>-i</code>, and <code>-</code></h2>
814814
<!-- (Section 5.4) -->
815815
<p>Add <code>-k</code> when running make to continue running even in the face of errors. Helpful if you want to see all the errors of Make at once.<br>Add a <code>-</code> before a command to suppress the error<br>Add <code>-i</code> to make to have this happen for every command.</p>
816816
<!-- (Section 5.4) -->
@@ -888,6 +888,7 @@ <h2 id="use-export-for-recursive-make">Use export for recursive make</h2>
888888

889889
<h2 id="arguments-to-make">Arguments to make</h2>
890890
<!-- (Section 9) -->
891+
891892
<p>There&#39;s a nice <a href="http://www.gnu.org/software/make/manual/make.html#Options-Summary">list of options</a> that can be run from make. Check out <code>--dry-run</code>, <code>--touch</code>, <code>--old-file</code>. </p>
892893
<p>You can have multiple targets to make, i.e. <code>make clean run test</code> runs the <code>clean</code> goal, then <code>run</code>, and then <code>test</code>.</p>
893894
<h1 id="variables-pt-2">Variables Pt. 2</h1>
@@ -1005,7 +1006,7 @@ <h2 id="pattern-specific-variables">Pattern-specific variables</h2>
10051006
echo one is nothing: <span class="hljs-variable">$(one)</span></code></pre>
10061007

10071008
<h1 id="conditional-part-of-makefiles">Conditional part of Makefiles</h1>
1008-
<h2 id="conditional-if-else">Conditional if/else</h2>
1009+
<h2 id="conditional-ifelse">Conditional if/else</h2>
10091010
<!-- (Section 7.1) -->
10101011
<pre><code class="hljs makefile">foo = ok
10111012

@@ -1043,7 +1044,7 @@ <h2 id="check-if-a-variable-is-defined">Check if a variable is defined</h2>
10431044
echo <span class="hljs-string">"but bar is not"</span>
10441045
<span class="hljs-keyword">endif</span></code></pre>
10451046

1046-
<h2 id="-makeflags-">$(makeflags)</h2>
1047+
<h2 id="makeflags">$(makeflags)</h2>
10471048
<!-- `(Section 7.3) -->
10481049
<p>This example shows you how to test make flags with <code>findstring</code> and <code>MAKEFLAGS</code>. Run this example with <code>make -i</code> to see it print out the echo statement.</p>
10491050
<pre><code class="hljs makefile">bar =
@@ -1087,6 +1088,7 @@ <h2 id="first-functions">First Functions</h2>
10871088
<!-- # 8.2, 8.3, 8.9 TODO do something about the fns
10881089
# TODO 8.7 origin fn? Better in documentation?
10891090
-->
1091+
10901092
<h2 id="string-substitution">String Substitution</h2>
10911093
<p><code>$(patsubst pattern,replacement,text)</code> does the following:</p>
10921094
<p>&quot;Finds whitespace-separated words in text that match pattern and replaces them with replacement. Here pattern may contain a ‘%’ which acts as a wildcard, matching any number of any characters within a word. If replacement also contains a ‘%’, the ‘%’ is replaced by the text that matched the ‘%’ in pattern. Only the first ‘%’ in the pattern and replacement is treated this way; any subsequent ‘%’ is unchanged.&quot; (<a href="https://www.gnu.org/software/make/manual/html_node/Text-Functions.html#Text-Functions">GNU docs</a>)</p>
@@ -1172,7 +1174,7 @@ <h2 id="multiline">Multiline</h2>
11721174
echo This line is too long, so \
11731175
it is broken up into multiple lines</code></pre>
11741176

1175-
<h2 id="-phony">.phony</h2>
1177+
<h2 id="phony">.phony</h2>
11761178
<p>Adding <code>.PHONY</code> to a target will prevent make from confusing the phony target with a file name. In this example, if the file <code>clean</code> is created, make clean will still be run. <code>.PHONY</code> is great to use, but I&#39;ll skip it in the rest of the examples for simplicity.</p>
11771179
<pre><code class="hljs makefile"><span class="hljs-section">some_file:</span>
11781180
touch some_file
@@ -1183,8 +1185,9 @@ <h2 id="-phony">.phony</h2>
11831185
rm -f some_file
11841186
rm -f clean</code></pre>
11851187

1186-
<h2 id="-delete_on_error">.delete_on_error</h2>
1188+
<h2 id="delete_on_error">.delete_on_error</h2>
11871189
<!-- (Section 5.4) -->
1190+
11881191
<p>The make tool will stop running a rule (and will propogate back to prerequisites) if a command returns a nonzero exit status.<br><code>DELETE_ON_ERROR</code> will delete the target of a rule if the rule fails in this manner. This will happen for all targets, not just the one it is before like PHONY. It&#39;s a good idea to always use this, even though make does not for historical reasons. </p>
11891192
<pre><code class="hljs makefile"><span class="hljs-section">.DELETE_ON_ERROR:</span>
11901193
<span class="hljs-section">all: one two</span>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"metalsmith-collections": "^0.9.0",
2121
"metalsmith-drafts": "^0.0.1",
2222
"metalsmith-layouts": "^1.6.5",
23-
"metalsmith-markdown": "^0.2.1",
23+
"metalsmith-markdown": "1.3.0",
2424
"metalsmith-metallic": "^2.0.1",
2525
"metalsmith-watch": "^1.0.3",
2626
"minimist": "^1.2.0"

yarn.lock

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -474,10 +474,12 @@ debug@^2.2.0, debug@~2.6.7:
474474
dependencies:
475475
ms "2.0.0"
476476

477-
debug@~0.7.4:
478-
version "0.7.4"
479-
resolved "https://registry.yarnpkg.com/debug/-/debug-0.7.4.tgz#06e1ea8082c2cb14e39806e22e2f6f757f92af39"
480-
integrity sha1-BuHqgILCyxTjmAbiLi9vdX+Srzk=
477+
debug@^4.1.1:
478+
version "4.3.3"
479+
resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.3.tgz#04266e0b70a98d4462e6e288e38259213332b664"
480+
integrity sha512-/zxw5+vh1Tfv+4Qn7a5nsbcJKPaSvCDhojn6FEl9vupwK2VCSDtEiEtqr8DFtzYFOdz63LBkxec7DYuc2jon6Q==
481+
dependencies:
482+
ms "2.1.2"
481483

482484
debug@~2.0.0:
483485
version "2.0.0"
@@ -1191,10 +1193,10 @@ map-obj@^1.0.0, map-obj@^1.0.1:
11911193
resolved "https://registry.yarnpkg.com/map-obj/-/map-obj-1.0.1.tgz#d933ceb9205d82bdcf4886f6742bdc2b4dea146d"
11921194
integrity sha1-2TPOuSBdgr3PSIb2dCvcK03qFG0=
11931195

1194-
marked@~0.3.9:
1195-
version "0.3.19"
1196-
resolved "https://registry.yarnpkg.com/marked/-/marked-0.3.19.tgz#5d47f709c4c9fc3c216b6d46127280f40b39d790"
1197-
integrity sha512-ea2eGWOqNxPcXv8dyERdSr/6FmzvWwzjMxpfGB/sbMccXoct+xY+YukPD+QTUZwyvK7BZwcr4m21WBOW41pAkg==
1196+
marked@^0.7.0:
1197+
version "0.7.0"
1198+
resolved "https://registry.yarnpkg.com/marked/-/marked-0.7.0.tgz#b64201f051d271b1edc10a04d1ae9b74bb8e5c0e"
1199+
integrity sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==
11981200

11991201
12001202
version "0.3.0"
@@ -1278,13 +1280,13 @@ metalsmith-layouts@^1.6.5:
12781280
lodash.omit "^4.0.2"
12791281
multimatch "^2.0.0"
12801282

1281-
metalsmith-markdown@^0.2.1:
1282-
version "0.2.2"
1283-
resolved "https://registry.yarnpkg.com/metalsmith-markdown/-/metalsmith-markdown-0.2.2.tgz#f863b7c9c0b2cd5bf034ee0899b0e5a8cde1ebd3"
1284-
integrity sha512-2WMtfd2xhBagmoyRZXg04EHd/jmWnK21aGOvEZG5/eDEBTn9zGtkeptZrl+fQV+CNwhWtoggn1s9d+yi0+JLqQ==
1283+
metalsmith-markdown@1.3.0:
1284+
version "1.3.0"
1285+
resolved "https://registry.yarnpkg.com/metalsmith-markdown/-/metalsmith-markdown-1.3.0.tgz#c250da93d5eb48f91bb2bea7b943f46f0672dc83"
1286+
integrity sha512-wStYRbJIYwNTDtHmVfb6RjNfFB+DkloIoQr600pXT2QRnbqMsdnAdSVfPjXX+vP7upCulZmp/xlcYzfDxKpx1w==
12851287
dependencies:
1286-
debug "~0.7.4"
1287-
marked "~0.3.9"
1288+
debug "^4.1.1"
1289+
marked "^0.7.0"
12881290

12891291
metalsmith-metallic@^2.0.1:
12901292
version "2.0.3"
@@ -1431,6 +1433,11 @@ [email protected]:
14311433
resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
14321434
integrity sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=
14331435

1436+
1437+
version "2.1.2"
1438+
resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009"
1439+
integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==
1440+
14341441
multimatch@^2.0.0, multimatch@^2.1.0:
14351442
version "2.1.0"
14361443
resolved "https://registry.yarnpkg.com/multimatch/-/multimatch-2.1.0.tgz#9c7906a22fb4c02919e2f5f75161b4cdbd4b2a2b"

0 commit comments

Comments
 (0)