initial commit

lib/functions/subshell/build_page.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+#############
+# DESCRIPTION
+#############
+# Builds a page from a source .md file and outputs the built version to 'index.html' in the same directory
+#
+#############
+# Usage: 
+# build_page source.md
+
+build_page() (
+
+# Switch to page directory
+page=$(basename $1)
+cd $(dirname $1)
+
+get_page_metadata $page
+
+if [[ $is_toc == "true" ]]; then
+        build_toc $page
+elif [[ $process_markdown == "false" ]]; then
+        build_header index.html
+        cat $page | sed -e '1,/END ARISE/d' | cat >> index.html
+        build_footer index.html
+else
+        build_header index.html
+        # Grab everything after the Arise metadata block, run it through pandoc to convert to html, and append to our file in progress
+        cat $page | sed -e '1,/END ARISE/d' | pandoc -f markdown -t html >> index.html
+        build_footer index.html
+fi
+
+# Inline Evaluations - DISABLED, WIP, ENABLE AT YOUR OWN PERIL
+# evaluate_inline index.html
+
+)

lib/functions/subshell/build_page_tree.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+#############                                                                                            
+# DESCRIPTION
+#############
+# Builds all pages on the site by calling "build_page" for every markdown file it can find outside of /config.
+#
+# Note that this function actually takes the root site directory to recursively build from as an argument.
+#
+#############
+# Usage:
+# build_page /path/to/arise-out/
+
+build_page_tree() (
+cd $1
+
+find . -type f -name "index.md" -not \( -path ./config -prune \) | while read fname; do
+build_page $fname
+
+# Add the source file to the list of files to remove in cleanup
+echo "$(realpath $fname)" >> $removelist
+done
+)

lib/functions/subshell/build_rss.sh

@@ -0,0 +1,78 @@
+#!/bin/bash
+#############                                                                                            
+# DESCRIPTION
+#############
+# Recursively crawls through the site and reads page metadata to generate an RSS feed for all content on the website.
+#
+# The script will output the completed RSS feed to the location specified as an argument.
+#
+#############
+# Usage:
+# build_rss rss.xml
+
+build_rss() (
+
+# Switch to rss file's directory
+touch $1
+rss=$(realpath $1)
+cd $(dirname $1)
+
+# Wipe out the existing rss feed, if there is one, and declare our new rss feed
+# Note that metadata descriptors are pulled from the index.md file that lives in the same folder as the destination for the rss.xml file.
+get_page_metadata index.md
+cat > $rss <<EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:media="http://search.yahoo.com/mrss/" version="2.0">
+  <channel>
+    <title>$global_name</title>
+    <description>$description</description>
+    <link>$base_url</link>
+    <language>$language</language>
+    <generator>Arise</generator>
+EOF
+
+[[ $favicon != '' ]] && {
+        cat >> $rss <<EOF
+    <image>
+      <url>$base_url$favicon</url>
+      <title>$global_name</title>
+      <link>$base_url</link>
+    </image>
+EOF
+}
+
+cat >> $rss <<EOF
+    <atom:link href="$base_url/rss.xml" rel="self" type="application/rss+xml"/>
+        <ttl>60</ttl>
+<lastBuildDate>$(date --rfc-822)</lastBuildDate>
+EOF
+
+# List every directory in our sitemap (except config). This makes up our sitemap since Arise is built to use directory roots as page URLs
+find . -type d -not \( -path ./config -prune \) | while read fname; do
+page_index=$(realpath "$fname"'/index.md')
+
+        if [ -e $page_index ]; then
+                get_page_metadata $page_index
+
+                if [[ $rss_hide != "true" ]] && [[ $is_toc != "true" ]]; then
+                        # Convert html's ISO8601 date to RSS's RFC-822. Fuck you RSS.
+                        rss_date=$(date -d "$published_date" --rfc-822)
+                        
+                        cat >> $rss <<EOF
+        <item>
+        <title>$title</title>
+        <dc:creator>$author</dc:creator>
+        <description>$description</description>
+        <link>$canonical_url</link>
+        <pubDate>$rss_date</pubDate>
+        </item>
+EOF
+                fi
+                clear_metadata
+        fi
+done
+
+# Close up the rss feed
+echo -e '</channel>\n</rss>' >> $rss
+
+)

lib/functions/subshell/build_sitemap.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+#############                                                                                            
+# DESCRIPTION
+#############
+# Automatically generates a sitemap at the given file location. 
+# 
+# Note that this function will map out your site using the specified location as the root of its mapping crawl. If you define a sitemap location in a subdirectory of your website, it will only map subfolders of that location.
+#
+#############
+# Usage:
+# build_sitemap /path/to/sitemap.xml
+
+build_sitemap() (
+
+# Switch to sitemap directory
+touch $1
+sitemap=$(basename $1)
+cd $(dirname $1)
+
+# Wipe out the existing sitemap, if there is one, and declare our new sitemap
+echo '<?xml version="1.0" encoding="UTF-8"?>' > $sitemap
+echo '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' >> $sitemap
+
+# List every directory in our sitemap (except config). This makes up our sitemap since Arise is built to use directory roots as page URLs
+find . -type d -not \( -path ./config -prune \) | while read fname; do
+        
+        # Rewrite the local path from the find command as the live web URL as the <loc> tag for the sitemap standard
+        echo -e '<url>\n<loc>'"$base_url"'/'"$(echo $fname | sed -n -e 's|\.\/||p')"'</loc>' >> $sitemap
+        
+        # If this page contains a Arise-style index page with a date modified, include that as a <lastmod> for the sitemap standard
+        modified_date=''
+        get_page_metadata $fname/index.md
+        if [ -n "$modified_date" ]; then
+                echo '<lastmod>'"$modified_date"'</lastmod>' >> $sitemap
+        fi
+        clear_metadata
+
+        # Close the <url> tag for the current URL being looped through
+        echo '</url>' >> $sitemap
+done
+
+# Close up the sitemap
+echo '</urlset>' >> $sitemap
+)

lib/functions/subshell/build_toc.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+#############                                                                                            
+# DESCRIPTION
+#############
+# Creates a table of contents at the location of the specified source file.
+# 
+#############
+# Usage:
+# build_toc index.md
+
+build_toc() (
+
+# Throw the metadata header together and add the source file to the list of files to remove in cleanup
+toc_source=$(basename $1)
+cd $(dirname $1)
+get_page_metadata $toc_source
+echo "$(realpath $toc_source)" >> $removelist
+build_header index.html
+
+# Add the title and start of the table for the TOC
+cat >> index.html <<EOF
+        <h1>$title</h1> 
+        <p id="arise-toc">
+        <table id="arise-toc-table">
+        <tr class="arise-toc-tr">
+                <th class="arise-toc-th">Date</th>
+                <th class="arise-toc-th">Title</th>
+                <th class="arise-toc-th">Description</th>
+        </tr>
+EOF
+clear_metadata
+
+# Make each entry into an individual table row. For now we're storing these in a temp file so that we can sort if after we're done generating all the entries in the TOC.
+toc_tmp="arise-toc-$RANDOM.tmp"
+find . -mindepth 2 -maxdepth 2 -type f -name 'index.md' | while read fname; do
+get_page_metadata $fname
+echo '<tr class="arise-toc-tr"><td class="arise-toc-td">'"$published_date"'</td><td class="arise-toc-td"><a href="'"$canonical_url"'">'"$title"'</a></td><td class="arise-toc-td">'"$description"'</td></tr>' >> $toc_tmp
+clear_metadata
+done
+
+# Sort all of our contents by date so that they're not in random order
+sort -r $toc_tmp >> index.html
+rm $toc_tmp
+
+# Final page bits
+cat >> index.html <<EOF
+        </table>
+        </p>
+EOF
+build_footer index.html
+)

lib/functions/subshell/evaluate_inline.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+#############
+# DESCRIPTION
+#############
+# Evaluates inline bash snippets when building pages.
+#
+# This functionality is currently disabled for initial release because even though it "works". When called by build_page, the parsing isn't very good and the syntax for calling an inline evaluation could use some work.
+#
+#############
+# Function Usage: 
+# evaluate_inline index.html
+#
+# Inline Snippet Usage:
+# <pre>sh# echo "Hello World!" </pre>
+
+evaluate_inline() (
+
+evaluation_source=$(basename $1)
+cd $(dirname $1)
+
+while grep "<pre>sh#" $evaluation_source
+do
+        replacement=$(bash <<< $(sed -n -e s$'\001''<pre>sh#\(.*\)</pre>'$'\001''\1'$'\001''p' < $evaluation_source | head -1))
+        awk 'NR==1,/<pre>sh#.*<\/pre>/{sub(/<pre>sh#.*<\/pre>/, "'"$replacement"'")}{print >"'"$evaluation_source"'"}' $evaluation_source || break
+done
+)