From ccdc95e4a8a2e31adf8613986af68b731607d210 Mon Sep 17 00:00:00 2001 From: Joel Coffman Date: Tue, 16 Apr 2024 01:26:44 -0600 Subject: [PATCH] doc(#269) Document the lack of support for Jekyll Compatibility with GitHub Pages is limited: Jekyll (and other static site generators) are not supported. This change documents this limitation on the home page and FAQs. Although Markdown files are converted to HTML and thus accessible when anonymized GitHub Pages is enabled for the repository, the Markdown to HTML conversion includes only the content -- i.e., there is no special formatting (as would be available when using Jekyll). For anyone who wants to use Jekyll, a potential workaround is to build the site locally and commit the generated site to the repository. Closes #269 Co-authored-by: Joel Coffman --- public/partials/faq.htm | 1 + public/partials/home.htm | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/public/partials/faq.htm b/public/partials/faq.htm index ef2fa8d..bc9d94b 100644 --- a/public/partials/faq.htm +++ b/public/partials/faq.htm @@ -80,6 +80,7 @@
  • Anonymous GitHub only anonymizes textual files. + It does not support the use of a static site generator, such as Jekyll, with GitHub Pages (although Markdown files are converted to HTML without any special formatting).
  • Anonymous GitHub does not support files that are larger than 8Mo. diff --git a/public/partials/home.htm b/public/partials/home.htm index 2380a0e..7aec4a2 100644 --- a/public/partials/home.htm +++ b/public/partials/home.htm @@ -96,7 +96,8 @@ The reviewers can explore your repository with ease, the source code is highlighted, PDFs, images, Notebook are rendered. The goal is to make is as easy as possible for the reviewer to explore and review - the repository. GitHub pages are also supported. + the repository. GitHub Pages + is also supported, but not static site generators, such as Jekyll.