diff --git a/blog/2023/10/18/create-a-blog-with-mkdocsmkdocs-material-mkdocs-rss-plugin-and-github-pages/index.html b/blog/2023/10/18/create-a-blog-with-mkdocsmkdocs-material-mkdocs-rss-plugin-and-github-pages/index.html index 2e91b61..77dac1c 100644 --- a/blog/2023/10/18/create-a-blog-with-mkdocsmkdocs-material-mkdocs-rss-plugin-and-github-pages/index.html +++ b/blog/2023/10/18/create-a-blog-with-mkdocsmkdocs-material-mkdocs-rss-plugin-and-github-pages/index.html @@ -15,7 +15,7 @@ - + diff --git a/blog/2023/01/31/hello-world-from-mkdocs-material/index.html b/blog/2023/10/18/hello-world-from-mkdocs-material/index.html similarity index 98% rename from blog/2023/01/31/hello-world-from-mkdocs-material/index.html rename to blog/2023/10/18/hello-world-from-mkdocs-material/index.html index 82f15fb..ade8c8a 100644 --- a/blog/2023/01/31/hello-world-from-mkdocs-material/index.html +++ b/blog/2023/10/18/hello-world-from-mkdocs-material/index.html @@ -12,11 +12,11 @@ - + - + @@ -581,7 +581,7 @@
...
diff --git a/blog/category/hello/index.html b/blog/category/hello/index.html index 9e77d67..922f4ff 100644 --- a/blog/category/hello/index.html +++ b/blog/category/hello/index.html @@ -573,7 +573,7 @@...
diff --git a/blog/category/world/index.html b/blog/category/world/index.html index 0990807..23e4198 100644 --- a/blog/category/world/index.html +++ b/blog/category/world/index.html @@ -573,7 +573,7 @@...
diff --git a/blog/index.html b/blog/index.html index a2b62fd..b32a842 100644 --- a/blog/index.html +++ b/blog/index.html @@ -712,7 +712,7 @@...
diff --git a/feed_rss_created.xml b/feed_rss_created.xml index 3ee8aa3..debb462 100644 --- a/feed_rss_created.xml +++ b/feed_rss_created.xml @@ -1 +1 @@ -Following is a list of relevant tags:
"},{"location":"tags/#devops","title":"DevOps","text":"A few time ago I maintained a blog with Wordpress. I was happy with it, but I wanted to try something new.
I tried Jekyll but it didn't convince me, I discovered mkdocs so I decided to use MkDocs and mkdocs-material. I was happy with the result, so I decided to write this post to explain how to create a blog with MkDocs, mkdocs-material and some plugins.
These is the first post of a serie of posts to create a blog with MkDocs, mkdocs-material and GitHub Pages and some customization.
Some knowledge:
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
Material for MkDocs is a theme for MkDocs, a static site generator geared towards (technical) project documentation. It is built using Google's Material Design guidelines. Material for MkDocs provides a polished and responsive experience out of the box, and it is as easy to use for the beginner as it is for the seasoned developer.
GitHub Pages is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website. You can see more information about GitHub Pages here.
This plugin generates an RSS feed for your MkDocs site. You can see more information about mkdocs-rss-plugin here.
Create a new repository on GitHub named username.github.io
, where username
is your username (or organization name) on GitHub. If the first part of the repository doesn\u2019t exactly match your username, it won\u2019t work, so make sure to get it right.
Go into the repository settings and, if you are not using GitHub Pages already, enable GitHub Pages on the gh-pages
branch.
Go to the folder where you want to store your project, and clone the new repository:
git clone ssh://github.com/username/username.github.io\ncd username.github.io\n
mkdocs==1.5.3\nmkdocs-material==9.4.6\nmkdocs-rss-plugin==1.8.0\n
bash python3 -m venv mysite source mysite/bin/activate pip install -r requirements.txt
mkdocs new .\n
For this post I am going to add the following configuration:
site_name: My Site \nsite_description: A blog about Azure, DevOps and other stuff\nsite_author: Rafael Fern\u00e1ndez\n\ntheme: \n name: material\n features:\n - navigation.tabs\n - navigation.expand\n - navigation.sections\n - toc.integrate\n - toc.nested\n - toc.smoothscroll\n - footer\n\nplugins:\n - search \n - blog\n - tags:\n tags_file: tags.md \n\n - rss:\n match_path: blog/posts/.* \n date_from_meta:\n as_creation: date\n categories:\n - categories\n - tags\n
mkdocs gh-deploy\n
","tags":["DevOps"]},{"location":"blog/2023/10/18/create-a-blog-with-mkdocsmkdocs-material-mkdocs-rss-plugin-and-github-pages/#urls","title":"urls","text":"...
"},{"location":"blog/archive/2023/","title":"2023","text":""},{"location":"blog/category/mkdocs/","title":"mkdocs","text":""},{"location":"blog/category/hello/","title":"Hello","text":""},{"location":"blog/category/world/","title":"World","text":""},{"location":"tags/","title":"Tags","text":"Following is a list of relevant tags:
"},{"location":"tags/#devops","title":"DevOps","text":"Following is a list of relevant tags:
"},{"location":"tags/#devops","title":"DevOps","text":"A few time ago I maintained a blog with Wordpress. I was happy with it, but I wanted to try something new.
I tried Jekyll but it didn't convince me, I discovered mkdocs so I decided to use MkDocs and mkdocs-material. I was happy with the result, so I decided to write this post to explain how to create a blog with MkDocs, mkdocs-material and some plugins.
These is the first post of a serie of posts to create a blog with MkDocs, mkdocs-material and GitHub Pages and some customization.
Some knowledge:
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
Material for MkDocs is a theme for MkDocs, a static site generator geared towards (technical) project documentation. It is built using Google's Material Design guidelines. Material for MkDocs provides a polished and responsive experience out of the box, and it is as easy to use for the beginner as it is for the seasoned developer.
GitHub Pages is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website. You can see more information about GitHub Pages here.
This plugin generates an RSS feed for your MkDocs site. You can see more information about mkdocs-rss-plugin here.
Create a new repository on GitHub named username.github.io
, where username
is your username (or organization name) on GitHub. If the first part of the repository doesn\u2019t exactly match your username, it won\u2019t work, so make sure to get it right.
Go into the repository settings and, if you are not using GitHub Pages already, enable GitHub Pages on the gh-pages
branch.
Go to the folder where you want to store your project, and clone the new repository:
git clone ssh://github.com/username/username.github.io\ncd username.github.io\n
mkdocs==1.5.3\nmkdocs-material==9.4.6\nmkdocs-rss-plugin==1.8.0\n
bash python3 -m venv mysite source mysite/bin/activate pip install -r requirements.txt
mkdocs new .\n
For this post I am going to add the following configuration:
site_name: My Site \nsite_description: A blog about Azure, DevOps and other stuff\nsite_author: Rafael Fern\u00e1ndez\n\ntheme: \n name: material\n features:\n - navigation.tabs\n - navigation.expand\n - navigation.sections\n - toc.integrate\n - toc.nested\n - toc.smoothscroll\n - footer\n\nplugins:\n - search \n - blog\n - tags:\n tags_file: tags.md \n\n - rss:\n match_path: blog/posts/.* \n date_from_meta:\n as_creation: date\n categories:\n - categories\n - tags\n
mkdocs gh-deploy\n
","tags":["DevOps"]},{"location":"blog/2023/10/18/create-a-blog-with-mkdocsmkdocs-material-mkdocs-rss-plugin-and-github-pages/#urls","title":"urls","text":"...
"},{"location":"blog/archive/2023/","title":"2023","text":""},{"location":"blog/category/mkdocs/","title":"mkdocs","text":""},{"location":"blog/category/hello/","title":"Hello","text":""},{"location":"blog/category/world/","title":"World","text":""},{"location":"tags/","title":"Tags","text":"Following is a list of relevant tags:
"},{"location":"tags/#devops","title":"DevOps","text":"