Merge pull request #1 from camchenry/add-eleventy-site

Merge to main
peggyjs · Jul 7, 2022 · 191a67f · 191a67f
2 parents 0f6e880 + 737c5b8
commit 191a67f
Show file tree

Hide file tree

Showing 11 changed files with 6,228 additions and 10 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -0,0 +1,16 @@
+name: Deploy to GitHub Pages
+
+on: workflow_dispatch
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Build
+        run: "cd docs && npm run build"
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_site
+          publish_branch: docs
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ pnpm-lock.yaml
 yarn.lock
 .nyc_output
 *.map
+docs/_site
diff --git a/docs/.eleventy.js b/docs/.eleventy.js
@@ -0,0 +1,23 @@
+module.exports = function (eleventyConfig) {
+  // Copy assets to the output directory as-is
+  eleventyConfig.addPassthroughCopy("img");
+  eleventyConfig.addPassthroughCopy("css");
+  eleventyConfig.addPassthroughCopy("js");
+  eleventyConfig.addPassthroughCopy("vendor");
+  eleventyConfig.addPassthroughCopy("favicon.ico");
+
+  return {
+    // Control which files Eleventy will process
+    // e.g.: *.md, *.njk, *.html, *.liquid
+    templateFormats: ["html", "njk"],
+    // Process .html files with nunjucks
+    htmlTemplateEngine: "njk",
+    // Path prefix for URLs
+    pathPrefix: "/",
+    // Config for input/output/data/etc. directories
+    dir: {
+      input: ".",
+      output: "_site",
+    },
+  };
+};
diff --git a/docs/development/benchmark.html → docs/development/benchmark.njk b/docs/development/benchmark.html → docs/development/benchmark.njk
@@ -1,3 +1,7 @@
+---
+permalink: '/development/benchmark.html'
+---
+
 <!DOCTYPE html>
 <html>
 

diff --git a/docs/development/index.html → docs/development/index.njk b/docs/development/index.html → docs/development/index.njk
@@ -1,3 +1,7 @@
+---
+permalink: '/development/index.html'
+---
+
 <!DOCTYPE html>
 <html>
 

diff --git a/docs/development/test.html → docs/development/test.njk b/docs/development/test.html → docs/development/test.njk
@@ -1,3 +1,7 @@
+---
+permalink: '/development/test.html'
+---
+
 <!DOCTYPE html>
 <html>
 

diff --git a/docs/documentation.html → docs/documentation.njk b/docs/documentation.html → docs/documentation.njk
@@ -1,3 +1,7 @@
+---
+permalink: '/documentation.html'
+---
+
 <!DOCTYPE html>
 <html>
 
@@ -153,7 +157,7 @@ <h3 id="generating-a-parser-command-line">Command Line</h3>
 <pre><code class="language-console">$ peggy arithmetics.pegjs</code></pre>
 
 <p>This writes parser source code into a file with the same name as the grammar
-file but with “.js” extension. You can also specify the output file
+file but with &ldquo;.js&rdquo; extension. You can also specify the output file
 explicitly:</p>
 
 <pre><code class="language-console">$ peggy -o arithmetics-parser.js arithmetics.pegjs</code></pre>
@@ -558,16 +562,16 @@ <h2 id="grammar-syntax-and-semantics">Grammar Syntax and Semantics</h2>
 first rule, which is also called the <em>start rule</em>.</p>
 
 <p>A rule name must be a JavaScript identifier. It is followed by an equality
-sign (“=”) and a parsing expression. If the rule has a human-readable name, it
+sign (&ldquo;=&rdquo;) and a parsing expression. If the rule has a human-readable name, it
 is written as a JavaScript string between the rule name and the equality sign.
 Rules need to be separated only by whitespace (their beginning is easily
-recognizable), but a semicolon (“;”) after the parsing expression is
+recognizable), but a semicolon (&ldquo;;&rdquo;) after the parsing expression is
 allowed.</p>
 
 <p>The first rule can be preceded by a <em>global initializer</em> and/or a
 <em>per-parse initializer</em>, in that order. Both are pieces of JavaScript
-code in double curly braces (“{{” and “}}”) and single curly braces (“{” and
-“}”) respectively. All variables and functions defined in both
+code in double curly braces (&ldquo;{{'{{'}}&rdquo; and &ldquo;}}&rdquo;) and single curly braces (&ldquo;{&rdquo; and
+&ldquo;}&rdquo;) respectively. All variables and functions defined in both
 <em>initializers</em> are accessible in rule actions and semantic predicates.
 Curly braces in both <em>initializers</em> code must be balanced.</p>
 <p>The <em>global initializer</em> is executed once and only once, when the
@@ -584,7 +588,7 @@ <h2 id="grammar-syntax-and-semantics">Grammar Syntax and Semantics</h2>
 <p>Let's look at the example grammar from above using a <em>global
 initializer</em> and a <em>per-parse initializer</em>:</p>
 
-<pre><code class="language-peggy">{{
+<pre><code class="language-peggy">{{'{{'}}
   function makeInteger(o) {
     return parseInt(o.join(""), 10);
   }
@@ -638,7 +642,7 @@ <h2 id="grammar-syntax-and-semantics">Grammar Syntax and Semantics</h2>
 match result when parsing is successful.</p>
 
 <p>One special case of parser expression is a <em>parser action</em> &mdash; a
-piece of JavaScript code inside curly braces (“{” and “}”) that takes match
+piece of JavaScript code inside curly braces (&ldquo;{&rdquo; and &ldquo;}&rdquo;) that takes match
 results of some of the the preceding expressions and returns a JavaScript value.
 This value is considered match result of the preceding expression (in other
 words, the parser action is a match result transformer).</p>
@@ -717,9 +721,9 @@ <h3 id="grammar-syntax-and-semantics-parsing-expression-types">Parsing Expressio
     <p>Match one character from a set and return it as a string. The characters
     in the list can be escaped in exactly the same way as in JavaScript string.
     The list of characters can also contain ranges (e.g. <code>[a-z]</code>
-    means “all lowercase letters”). Preceding the characters with <code>^</code>
-    inverts the matched set (e.g. <code>[^a-z]</code> means “all character but
-    lowercase letters”). Appending <code>i</code> right after the literal makes
+    means &ldquo;all lowercase letters&rdquo;). Preceding the characters with <code>^</code>
+    inverts the matched set (e.g. <code>[^a-z]</code> means &ldquo;all character but
+    lowercase letters&rdquo;). Appending <code>i</code> right after the literal makes
     the match case-insensitive.</p>
 
     <div class="example">

diff --git a/docs/index.html → docs/index.njk b/docs/index.html → docs/index.njk
@@ -1,3 +1,7 @@
+---
+permalink: '/index.html'
+---
+
 <!DOCTYPE html>
 <html>
 

diff --git a/docs/online.html → docs/online.njk b/docs/online.html → docs/online.njk
@@ -1,3 +1,6 @@
+---
+permalink: "/online.html"
+---
 <!DOCTYPE html>
 <html>