Skip to content
This repository was archived by the owner on Aug 20, 2020. It is now read-only.

Commit 9510c74

Browse files
committed
fixed some doc links and renderings
1 parent 0e221ed commit 9510c74

5 files changed

Lines changed: 104 additions & 0 deletions

File tree

assets/liblogo.gif

4.33 KB
Loading

assets/orangebooks-logo-icon.png

1.48 KB
Loading

assets/orangebooks-logo.png

10 KB
Loading

docs/rss2json.html

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Caltech Library's Digital Library Development Sandbox</title>
5+
<link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
6+
<link rel="stylesheet" href="/css/site.css">
7+
</head>
8+
<body>
9+
<header>
10+
<a href="http://library.caltech.edu"><img src="/assets/liblogo.gif" alt="Caltech Library logo"></a>
11+
</header>
12+
<nav>
13+
<ul>
14+
<li><a href="/">Home</a></li>
15+
<li><a href="../index.html">README</a></li>
16+
<li><a href="../license.html">LICENSE</a></li>
17+
<li><a href="../install.html">INSTALL</a></li>
18+
<li><a href="./">Documentation</a></li>
19+
<li><a href="https://github.com/caltechlibrary/rss2">Github</a></li>
20+
</ul>
21+
22+
</nav>
23+
24+
<section>
25+
<h1>USAGE</h1>
26+
27+
<pre><code>rss2json [OPTIONS] INPUT_RSS_XML_FILENAME [OUTPUT_JSON_FILENAME]
28+
</code></pre>
29+
30+
<h2>SYNOPSIS</h2>
31+
32+
<p>rss2json is a program that converts RSS v2&rsquo;s XML to JSON.</p>
33+
34+
<h2>OPTIONS</h2>
35+
36+
<pre><code> -examples display examples
37+
-generate-markdown-docs generate Markdown documentation
38+
-h, -help display help
39+
-i, -input set input filename
40+
-l, -license display license
41+
-nl, -newline add trailing newline
42+
-o, -output set output filename
43+
-p, -pretty pretty print XML output
44+
-quiet suppress error messages
45+
-v, -version display version
46+
</code></pre>
47+
48+
<h2>EXAMPLES</h2>
49+
50+
<p>Convert <em>rss.xml</em> to <em>rss.json</em>.</p>
51+
52+
<pre><code>rss2json rss.xml rss.json
53+
</code></pre>
54+
55+
<p>rss2json v0.0.2</p>
56+
57+
</section>
58+
59+
<footer>
60+
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span>
61+
<span>&copy; 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span>
62+
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
63+
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
64+
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
65+
<a class="cl-hide" href="sitemap.xml">Site Map</a>
66+
</footer>
67+
</body>
68+
</html>

docs/rss2json.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
# USAGE
3+
4+
rss2json [OPTIONS] INPUT_RSS_XML_FILENAME [OUTPUT_JSON_FILENAME]
5+
6+
## SYNOPSIS
7+
8+
9+
rss2json is a program that converts RSS v2's XML to JSON.
10+
11+
12+
## OPTIONS
13+
14+
```
15+
-examples display examples
16+
-generate-markdown-docs generate Markdown documentation
17+
-h, -help display help
18+
-i, -input set input filename
19+
-l, -license display license
20+
-nl, -newline add trailing newline
21+
-o, -output set output filename
22+
-p, -pretty pretty print XML output
23+
-quiet suppress error messages
24+
-v, -version display version
25+
```
26+
27+
28+
## EXAMPLES
29+
30+
31+
Convert *rss.xml* to *rss.json*.
32+
33+
rss2json rss.xml rss.json
34+
35+
36+
rss2json v0.0.2

0 commit comments

Comments
 (0)