diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 4f95505..7485afd 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -56,11 +56,26 @@ jobs: - name: Build documentation run: ~/.elan/bin/lake -Kenv=dev build HepLean:docs + - name: Copy documentation to `docs/docs` + run: | + mv .lake/build/doc doc/docs + + - name: Bundle dependencies + uses: ruby/setup-ruby@v1 + with: + working-directory: doc + ruby-version: "3.1" # Not needed with a .ruby-version file + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + + + - name: Bundle website + working-directory: doc + run: JEKYLL_ENV=production bundle exec jekyll build - name: Upload docs & blueprint artifact uses: actions/upload-pages-artifact@v1 with: - path: .lake/build/doc + path: doc/_site - name: Deploy to GitHub Pages id: deployment diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..f40fbd8 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,5 @@ +_site +.sass-cache +.jekyll-cache +.jekyll-metadata +vendor diff --git a/doc/404.html b/doc/404.html new file mode 100644 index 0000000..086a5c9 --- /dev/null +++ b/doc/404.html @@ -0,0 +1,25 @@ +--- +permalink: /404.html +layout: default +--- + + + +
+

404

+ +

Page not found :(

+

The requested page could not be found.

+
diff --git a/doc/Gemfile b/doc/Gemfile new file mode 100644 index 0000000..ec26d64 --- /dev/null +++ b/doc/Gemfile @@ -0,0 +1,7 @@ +# Gemfile + +source 'https://rubygems.org' + +gem "jekyll", "~> 4.2" + +gem "minima", git: "https://github.com/jekyll/minima" \ No newline at end of file diff --git a/doc/Gemfile.lock b/doc/Gemfile.lock new file mode 100644 index 0000000..5d1f0ec --- /dev/null +++ b/doc/Gemfile.lock @@ -0,0 +1,117 @@ +GIT + remote: https://github.com/jekyll/minima + revision: 1d5286cf9a1aae34078420d183d560dd673d98b5 + specs: + minima (3.0.0.dev) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + +GEM + remote: https://rubygems.org/ + specs: + addressable (2.8.6) + public_suffix (>= 2.0.2, < 6.0) + bigdecimal (3.1.8) + colorator (1.1.0) + concurrent-ruby (1.3.3) + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + eventmachine (1.2.7) + ffi (1.17.0) + ffi (1.17.0-arm64-darwin) + ffi (1.17.0-x86_64-darwin) + forwardable-extended (2.6.0) + google-protobuf (4.27.1) + bigdecimal + rake (>= 13) + google-protobuf (4.27.1-arm64-darwin) + bigdecimal + rake (>= 13) + google-protobuf (4.27.1-x86_64-darwin) + bigdecimal + rake (>= 13) + http_parser.rb (0.8.0) + i18n (1.14.5) + concurrent-ruby (~> 1.0) + jekyll (4.3.3) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 1.0) + jekyll-sass-converter (>= 2.0, < 4.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.3, >= 2.3.1) + kramdown-parser-gfm (~> 1.0) + liquid (~> 4.0) + mercenary (>= 0.3.6, < 0.5) + pathutil (~> 0.9) + rouge (>= 3.0, < 5.0) + safe_yaml (~> 1.0) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) + jekyll-feed (0.17.0) + jekyll (>= 3.7, < 5.0) + jekyll-sass-converter (3.0.0) + sass-embedded (~> 1.54) + jekyll-seo-tag (2.8.0) + jekyll (>= 3.8, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.4) + listen (3.9.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (5.1.0) + rake (13.2.1) + rb-fsevent (0.11.2) + rb-inotify (0.11.1) + ffi (~> 1.0) + rexml (3.3.0) + strscan + rouge (4.3.0) + safe_yaml (1.0.5) + sass-embedded (1.77.5) + google-protobuf (>= 3.25, < 5.0) + rake (>= 13) + sass-embedded (1.77.5-aarch64-mingw-ucrt) + google-protobuf (>= 3.25, < 5.0) + sass-embedded (1.77.5-arm64-darwin) + google-protobuf (>= 3.25, < 5.0) + sass-embedded (1.77.5-x86-cygwin) + google-protobuf (>= 3.25, < 5.0) + sass-embedded (1.77.5-x86-mingw-ucrt) + google-protobuf (>= 3.25, < 5.0) + sass-embedded (1.77.5-x86_64-cygwin) + google-protobuf (>= 3.25, < 5.0) + sass-embedded (1.77.5-x86_64-darwin) + google-protobuf (>= 3.25, < 5.0) + strscan (3.1.0) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + unicode-display_width (2.5.0) + webrick (1.8.1) + +PLATFORMS + aarch64-mingw-ucrt + arm64-darwin-23 + ruby + x86-cygwin + x86-mingw-ucrt + x86_64-cygwin + x86_64-darwin + +DEPENDENCIES + jekyll (~> 4.2) + minima! + +BUNDLED WITH + 2.5.13 diff --git a/doc/_config.yml b/doc/_config.yml new file mode 100644 index 0000000..1cb2684 --- /dev/null +++ b/doc/_config.yml @@ -0,0 +1,57 @@ +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your whole blog, values +# which you are expected to set up once and rarely edit after that. If you find +# yourself editing this file very often, consider using Jekyll's data files +# feature for the data you need to update frequently. +# +# For technical reasons, this file is *NOT* reloaded automatically when you use +# 'bundle exec jekyll serve'. If you change this file, please restart the server process. +# +# If you need help with YAML syntax, here are some quick references for you: +# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml +# https://learnxinyminutes.com/docs/yaml/ +# +# Site settings +# These are used to personalize your new site. If you look in the HTML files, +# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. +# You can create any custom variable you would like, and they will be accessible +# in the templates via {{ site.myvariable }}. + +title: "HepLean: Digitalizing High-Energy Physics in Lean 4" +#email: HEPLean +description: >- # this means to ignore newlines until "baseurl:" + A project to digitalize results from high-energy physics into Lean 4. +baseurl: "/HepLean" # the subpath of your site, e.g. /blog +url: "https://heplean.github.io" # the base hostname & protocol for your site, e.g. http://example.com +#twitter_username: jekyllrb +github_username: "HEPLean" + +# Build settings +theme: minima + +minima: + skin: solarized + +author: + name: HEPLean + email: " " + +# The following items will not be processed, by default. +# Any item listed under the `exclude:` key here will be automatically added to +# the internal "default list". +# +# Excluded items can be processed by explicitly listing the directories or +# their entries' file path in the `include:` list. +# +# exclude: +# - .sass-cache/ +# - .jekyll-cache/ +# - gemfiles/ +# - Gemfile +# - Gemfile.lock +# - node_modules/ +# - vendor/bundle/ +# - vendor/cache/ +# - vendor/gems/ +# - vendor/ruby/ diff --git a/doc/index.markdown b/doc/index.markdown new file mode 100644 index 0000000..a3ea455 --- /dev/null +++ b/doc/index.markdown @@ -0,0 +1,12 @@ +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults + +layout: home +--- +[![](https://img.shields.io/badge/Documentation-blue)](https://heplean.github.io/HepLean/docs) +[![](https://img.shields.io/badge/GitHub-blue)](https://github.com/HEPLean/HepLean) + +(This site is a work in progress. More to follow. Follow the links above to +the documentation page or GitHub.) +