Skip to content

Commit

Permalink
Add the blog feature from mkdocs-material
Browse files Browse the repository at this point in the history
  • Loading branch information
jobindjohn committed Dec 13, 2023
1 parent c7a31de commit a953456
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 3 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ jobs:
path: .cache
- run: pip install mkdocs-material
- run: pip install mkdocs-roamlinks-plugin
- run: pip install mkdocs-rss-plugin
# - run: pip install mkdocs-mermaid2-plugin
- run: mkdocs gh-deploy --force
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@

Would you like to take _some_ of your notes in [Obsidian](https://obsidian.md/) and make it public?

This template gives you an easy (and automated) way to publish your Obsidian notes on your Github pages.
This template gives you an easy (and automated) way to publish your Obsidian notes (or blog!) on your Github pages.

With this template, you get these **out-of-the-box**:

- an awesome website based on Material theme, complete with a search bar (Checkout this template repo published [here](https://jobindjohn.github.io/obsidian-publish-mkdocs/))
![](2021-11-22-22-49-26.png)
- get the Obsidian/Roam style `[[wikilinks]]` from your vault in your published notes
- Toggle between light and dark mode
- Blog folder

## Quick start

Expand Down
2 changes: 2 additions & 0 deletions docs/blog/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Blog

21 changes: 21 additions & 0 deletions docs/blog/posts/hello-world.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
draft: true
date: 2023-01-31
slug: hello-world
categories:
- Hello
- World
tags:
- template
- how-to
---


# Hello World Blogpost

Blog excerpt here

<!-- more -->

Rest of blog here
...
11 changes: 9 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,15 @@ markdown_extensions:

plugins:
- search
- roamlinks

- roamlinks
- blog
- rss:
match_path: blog/posts/.*
date_from_meta:
as_creation: date
categories:
- categories
- tags

extra_javascript:
- javascripts/mathjax.js
Expand Down

0 comments on commit a953456

Please sign in to comment.