Skip to content

Commit

Permalink
Add Jekyll plugins for dealing with plain Markup and github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mgroeber9110 committed Nov 15, 2023
1 parent da34a4c commit adc56fa
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 4 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ jobs:
id: pages
uses: actions/configure-pages@v3
- name: Build with Jekyll
# Outputs to the './_site' directory by default
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
# Outputs to the './_site' directory by default
run: bundle exec jekyll build --verbose --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v1
with:
path: "TechDocs/Markdown/_site/"
Expand Down
8 changes: 8 additions & 0 deletions TechDocs/Markdown/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,11 @@ gem "jekyll", "~> 4.3.2" # installed by `gem jekyll`

gem "just-the-docs", "0.7.0" # pinned to the current release
# gem "just-the-docs" # always download the latest release

group :jekyll_plugins do
gem "jekyll-github-metadata"
gem "jekyll-relative-links"
gem "jekyll-optional-front-matter"
gem "jekyll-titles-from-headings"
gem "jekyll-default-layout"
end
34 changes: 34 additions & 0 deletions TechDocs/Markdown/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,23 @@ GEM
specs:
addressable (2.8.5)
public_suffix (>= 2.0.2, < 6.0)
base64 (0.2.0)
colorator (1.1.0)
concurrent-ruby (1.2.2)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
faraday (2.7.11)
base64
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2)
ffi (1.15.5)
ffi (1.15.5-x64-mingw-ucrt)
forwardable-extended (2.6.0)
google-protobuf (3.24.3-arm64-darwin)
google-protobuf (3.24.3-x64-mingw-ucrt)
google-protobuf (3.24.3-x86_64-linux)
http_parser.rb (0.8.0)
i18n (1.14.1)
Expand All @@ -32,12 +40,23 @@ GEM
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-default-layout (0.1.5)
jekyll (>= 3.0, < 5.0)
jekyll-github-metadata (2.16.0)
jekyll (>= 3.4, < 5.0)
octokit (>= 4, < 7, != 4.4.0)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-optional-front-matter (0.3.2)
jekyll (>= 3.0, < 5.0)
jekyll-relative-links (0.7.0)
jekyll (>= 3.3, < 5.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-titles-from-headings (0.5.3)
jekyll (>= 3.3, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
just-the-docs (0.7.0)
Expand All @@ -54,6 +73,9 @@ GEM
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
octokit (6.1.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.3)
Expand All @@ -63,22 +85,34 @@ GEM
ffi (~> 1.0)
rexml (3.2.6)
rouge (4.1.3)
ruby2_keywords (0.0.5)
safe_yaml (1.0.5)
sass-embedded (1.67.0-arm64-darwin)
google-protobuf (~> 3.23)
sass-embedded (1.67.0-x64-mingw-ucrt)
google-protobuf (~> 3.23)
sass-embedded (1.67.0-x86_64-linux-gnu)
google-protobuf (~> 3.23)
sawyer (0.9.2)
addressable (>= 2.3.5)
faraday (>= 0.17.3, < 3)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.4.2)
webrick (1.8.1)

PLATFORMS
arm64-darwin-23
x64-mingw-ucrt
x86_64-linux

DEPENDENCIES
jekyll (~> 4.3.2)
jekyll-default-layout
jekyll-github-metadata
jekyll-optional-front-matter
jekyll-relative-links
jekyll-titles-from-headings
just-the-docs (= 0.7.0)

BUNDLED WITH
Expand Down
11 changes: 10 additions & 1 deletion TechDocs/Markdown/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,13 @@ gh_edit_link_text: "Edit this page on GitHub."
gh_edit_repository: "https://github.com/mgroeber9110/just-the-docs-test"
gh_edit_branch: "main"
gh_edit_source: "TechDocs/Markdown"
gh_edit_view_mode: "tree"
gh_edit_view_mode: "tree"

# Jekyll plugins to simplify working with plain Markdown files
# (copied from default gh-pages action)
plugins:
- jekyll-github-metadata
- jekyll-relative-links
- jekyll-optional-front-matter
- jekyll-titles-from-headings
- jekyll-default-layout

0 comments on commit adc56fa

Please sign in to comment.