docs: add Jekyll theme

This also includes a link to the GitHub repo from the generated GitHub Pages site. Fixes #58
MikeLankamp · May 9, 2024 · fdd9d8b · fdd9d8b
1 parent 22bab8f
commit fdd9d8b
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 0 deletions.
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "github-pages"
+gem "jekyll-relative-links"
+gem "jekyll-github-metadata"
+
+gem "webrick", "~> 1.8"
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,10 @@
+title: FPM
+description: C++ header-only fixed-point math library
+theme: jekyll-theme-slate
+site:
+  github:
+    - is_project_page
+    - repository_url: https://github.com/MikeLankamp/fpm
+gems:
+  - jekyll-relative-links
+  - jekyll-github-metadata
diff --git a/docs/accuracy.md b/docs/accuracy.md
@@ -1,3 +1,6 @@
+---
+layout: default
+---
 # Accuracy
 
 The images below compare the accuracy (versus the real result) of:

diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,6 @@
+---
+layout: default
+---
 # fpm
 A C++ header-only fixed-point math library. "fpm" stands for "fixed-point math".
 

diff --git a/docs/performance.md b/docs/performance.md
@@ -1,3 +1,6 @@
+---
+layout: default
+---
 # Performance
 
 The image below shows the approximate performance of: