Skip to content

Commit

Permalink
Merge pull request #17 from josh-wong/remove-material-for-mkdocs-insi…
Browse files Browse the repository at this point in the history
…ders

Remove Material for MkDocs Insiders
  • Loading branch information
josh-wong authored Sep 2, 2023
2 parents aeb83e8 + 6fe4c35 commit 2b3dafc
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 55 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,4 @@ jobs:
key: ${{ github.ref }}
path: .cache
- run: pip install -r requirements.txt
- run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
- run: make deploy
- run: mkdocs gh-deploy --force
6 changes: 0 additions & 6 deletions Makefile

This file was deleted.

46 changes: 0 additions & 46 deletions mkdocs.insiders.yml

This file was deleted.

34 changes: 33 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ repo_url: https://github.com/josh-wong/josh-wong.github.io/
docs_dir: blog

plugins:
- blog:
blog_dir: .
pagination_per_page: 5
pagination_template: "$link_first $link_previous ~2~ $link_next $link_last"
pagination_url_format: "page/{page}"
post_url_date_format: yyyy/MM
post_url_format: "blog/{date}/{slug}"
- meta
- minify:
minify_html: true
- mkdocs-video:
Expand All @@ -16,7 +24,31 @@ plugins:
- redirects:
redirect_maps:
'blog/index.md': 'index.md'
#- search # Enable the search function (currently disabled to take advantage of new search features in Material for MkDocs Insiders)
- rss:
abstract_chars_count: 250 # -1 for full content
categories:
- categories
- tags
comments_path: "#__comments"
date_from_meta:
as_creation: "date"
as_update: false
datetime_format: "%Y-%m-%d %H:%M"
default_timezone: Asia/Tokyo
enabled: true
feed_ttl: 1440
image: https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.png
length: 20
pretty_print: false
match_path: "posts/.*"
url_parameters:
utm_source: "documentation"
utm_medium: "RSS"
utm_campaign: "feed-syndication"
- search
- social # Enable support for social cards (pretty link previews)
- tags:
tags_file: tags.md
#- techdocs-core # Many plugins need to be disabled for TechDocs to work properly, so this is currently disabled. I enable this plugin when testing Backstage with TechDocs.

markdown_extensions:
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ cairosvg
jinja2>=3.0
markdown>=3.2
mkdocs>=1.4.2
mkdocs-material
# Show docs contributors
mkdocs-git-committers-plugin-2
# Show the last updated date (currently disabled since this is a home page that primarily includes a blog and links to projects)
Expand Down

0 comments on commit 2b3dafc

Please sign in to comment.