From fdd9d8ba1e1200d89f60fc7b0dfa70024a39e840 Mon Sep 17 00:00:00 2001 From: Mike Lankamp Date: Thu, 9 May 2024 23:39:47 +0200 Subject: [PATCH] docs: add Jekyll theme This also includes a link to the GitHub repo from the generated GitHub Pages site. Fixes #58 --- docs/Gemfile | 9 +++++++++ docs/_config.yml | 10 ++++++++++ docs/accuracy.md | 3 +++ docs/index.md | 3 +++ docs/performance.md | 3 +++ 5 files changed, 28 insertions(+) create mode 100644 docs/Gemfile create mode 100644 docs/_config.yml diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000..3a33d2f --- /dev/null +++ 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 new file mode 100644 index 0000000..8acaf5f --- /dev/null +++ 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 index 8a9c462..b8ec7ac 100644 --- 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 index 9f71901..ec55581 100644 --- 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 index b4b0b2f..4e3b6af 100644 --- a/docs/performance.md +++ b/docs/performance.md @@ -1,3 +1,6 @@ +--- +layout: default +--- # Performance The image below shows the approximate performance of: