This repository has been archived by the owner on Jun 27, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
/
frontmatter.html
94 lines (77 loc) · 2.97 KB
/
frontmatter.html
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
<!DOCTYPE html>
<html>
<head>
<title>Caltech Library's Digital Library Development Sandbox</title>
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu"><img src="/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="../">Up</a></li>
<li><a href="./mkrss.html">mkrss</a></li>
<li><a href="./mkpage.html">mkpage</a></li>
<li><a href="./urlencode.html">urlencode</a></li>
<li><a href="./go-template-recipes.html">Go text/template recipes</a></li>
<li><a href="./titleline.html">titleline</a></li>
<li><a href="./mkslides.html">mkslides</a></li>
<li><a href="./slides/three-slides.html">Title Page</a></li>
<li><a href="./slides/presentation.html">What is mkslides?</a></li>
<li><a href="./byline.html">byline</a></li>
<li><a href="./ws.html">ws</a></li>
<li><a href="./frontmatter.html">frontmatter</a></li>
<li><a href="./mkpongo.html">mkpongo</a></li>
<li><a href="./urldecode.html">urldecode</a></li>
<li><a href="./sitemapper.html">sitemapper</a></li>
<li><a href="./reldocpath.html">reldocpath</a></li>
</ul>
</nav>
<section>
<h1>frontmatter</h1>
<h2>USAGE</h2>
<pre><code>frontmatter [OPTIONS]
</code></pre>
<h3>DESCRIPTION</h3>
<p><em>frontmatter</em> extracts a front matter from a Markdown file.
If no front matter is present then an empty file
is returned. Note <em>frontmatter</em> doesn’t process the data
extracted. It returns it unprocessed. Other tools can
be used to process the front matter appropriately.
By default <em>frontmatter</em> reads from standard in and writes
to standard out. This makes it very suitable for pipeline
processing or for passing JSON formatted front matter back
to <em>mkpage</em> for integration into the templates processed.</p>
<h3>OPTIONS</h3>
<p>Below are a set of options available.</p>
<pre><code> -examples display example(s)
-generate-manpage generate man page
-generate-markdown generate Markdown documentation
-h, -help display help
-i, -input input filename
-l, -license display license
-o, -output output filename
-quiet suppress error messages
-v, -version display version
</code></pre>
<h3>EXAMPLES</h3>
<p>Extract a front matter from article.md.</p>
<pre><code>cat article.md | frontmatter
</code></pre>
<p>This will display the front matter if found in article.md.</p>
<pre><code>frontmatter -i article.md
</code></pre>
<p>Will also do the same.</p>
</section>
<footer>
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span>
<span>© 2020 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
<a class="cl-hide" href="sitemap.xml">Site Map</a>
</footer>
</body>
</html>