Skip to content

Commit 2536331

Browse files
committed
Add initial Jekyll configuration file with essential settings
1 parent 83157ea commit 2536331

File tree

2 files changed

+108
-5
lines changed

2 files changed

+108
-5
lines changed

.github/workflows/docs.yml

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ on:
55
- main
66
workflow_dispatch:
77

8+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
15+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
820
jobs:
921
build:
1022
name: Deploy docs
@@ -13,8 +25,24 @@ jobs:
1325
- name: Checkout main
1426
uses: actions/checkout@v2
1527

16-
- name: Deploy docs
17-
uses: mhausenblas/mkdocs-deploy-gh-pages@master
18-
env:
19-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
20-
REQUIREMENTS: requirements.txt
28+
- name: Setup Pages
29+
uses: actions/configure-pages@v5
30+
- name: Build with Jekyll
31+
uses: actions/jekyll-build-pages@v1
32+
with:
33+
source: ./
34+
destination: ./_site
35+
- name: Upload artifact
36+
uses: actions/upload-pages-artifact@v3
37+
38+
# Deployment job
39+
deploy:
40+
environment:
41+
name: github-pages
42+
url: ${{ steps.deployment.outputs.page_url }}
43+
runs-on: ubuntu-latest
44+
needs: build
45+
steps:
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

_config.yml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Where things are
2+
source : .
3+
destination : ./_site
4+
collections_dir : .
5+
plugins_dir : _plugins # takes an array of strings and loads plugins in that order
6+
layouts_dir : _layouts
7+
data_dir : _data
8+
includes_dir : _includes
9+
sass:
10+
sass_dir: _sass
11+
collections:
12+
posts:
13+
output : true
14+
15+
# Handling Reading
16+
safe : true
17+
include : [".htaccess"]
18+
exclude : ["Gemfile", "Gemfile.lock", "node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
19+
keep_files : [".git", ".svn"]
20+
encoding : "utf-8"
21+
markdown_ext : "markdown,mkdown,mkdn,mkd,md"
22+
strict_front_matter : false
23+
24+
# Filtering Content
25+
show_drafts : null
26+
limit_posts : 0
27+
future : false
28+
unpublished : false
29+
30+
# Plugins
31+
whitelist : []
32+
plugins : []
33+
34+
# Conversion
35+
markdown : kramdown
36+
highlighter : rouge
37+
lsi : false
38+
excerpt_separator : "\n\n"
39+
incremental : false
40+
41+
# Serving
42+
detach : false
43+
port : 4000
44+
host : 127.0.0.1
45+
baseurl : "" # does not include hostname
46+
show_dir_listing : false
47+
48+
# Outputting
49+
permalink : date
50+
paginate_path : /page:num
51+
timezone : null
52+
53+
quiet : false
54+
verbose : false
55+
defaults : []
56+
57+
liquid:
58+
error_mode : warn
59+
strict_filters : false
60+
strict_variables : false
61+
62+
# Markdown Processors
63+
kramdown:
64+
auto_ids : true
65+
entity_output : as_char
66+
toc_levels : [1, 2, 3, 4, 5, 6]
67+
smart_quotes : lsquo,rsquo,ldquo,rdquo
68+
input : GFM
69+
hard_wrap : false
70+
footnote_nr : 1
71+
show_warnings : false
72+
math_engine : mathjax
73+
syntax_highlighter: rouge
74+
75+
theme: jekyll-theme-hacker

0 commit comments

Comments
 (0)