I have decided to create a new category on my blog to talk about Azure services.
The main goal of this category is to provide a quick overview of some Azure services and some design considerations.
What is this category due to?
In some cases, it is because I am working with this Service and I think it is a good idea to share my experience with you and write it down for me, in others, it is because I am studying/reviewing an Azure Service and I think it is a good idea. Share my notes with you.
First, I need to clarify that I'm not a C# developer. I'm learning C# so I can better understand the code that has to be deployed to some Azure services when .NET is used.
If someone that knows me is reading this post, he/she will be thinking:
"What the hell is he doing?"
"He is crazy"
"He is going to die trying".
The end of the world is approaching!!
Maybe the last thought can be really true but I have to say that I have decided to learn a programming language and that I have chosen C# because many of the examples for Azure Developers that I have seen are written in C#.
I repeat, I am not a developer but I'd like to share with you my experience learning C#.
Trunk is a tool that runs a suite of security and best practice checks against your code. It is designed to be used in CI/CD pipelines, but can also be used as a standalone tool.
Support for the following languages is currently available:
One of the flagship features of Material for MkDocs is the ability to inject annotations – little markers that can be added almost anywhere in a document and expand a tooltip containing arbitrary Markdown on click or keyboard focus.
This is a paragraph with a annotation(1).
{ .annotate }
1. :man_raising_hand: I'm an annotation! I can contain `code`, __formatted
text__, images, ... basically anything that can be expressed in Markdown.
This is a paragraph with a annotation(1).
I'm an annotation! I can contain code, formatted
text, images, ... basically anything that can be expressed in Markdown.
This is a paragraph with a annotation(1).
{ .annotate }
1. :man_raising_hand: I'm an annotation! with a nested annotation(1)
{ .annotate }
1. I'm a nested annotation!
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’t exactly match your username, it won’t work, so make sure to get it right.
For this post I am going to add the following configuration:
basic configuration
configuration for theme mkdocs-material
some native plugins of mkdocs-material and some ones that I like
site_name:My Sitesite_description:A blog about Azure, DevOps and other stuffsite_author:Rafael Fernándeztheme:name:materialfeatures:-navigation.tabs-navigation.expand-navigation.sections-toc.integrate-toc.nested-toc.smoothscroll-footerplugins:-search-blog-tags:tags_file:tags.md-rss:match_path:blog/posts/.*date_from_meta:as_creation:datecategories:-categories-tags
In blog/post folder create a new folder with the name of the post and create a new file with the name of the post and the extension .md. For example: welcome.md
At some point, GitHub renamed master to main. If your default branch
is named master, you can safely remove main, vice versa.
Store the cache_id environmental variable to access it later during cache
key creation. The name is case-sensitive, so be sure to align it with ${{ env.cache_id }}.
The --utc option makes sure that each workflow runner uses the same time zone.
The %V format assures a cache update once a week.
You can change the format to %F to have daily cache updates.
You can read the [manual page] to learn more about the formatting options of the date command.
Add [MkDocs plugins] or Markdown
extensions with pip to requirements.txt to be used during the build.
In the next post I will explain how to customize your site with mkdocs-material and some plugins writing mkdocs.yml.