title |
---|
Configuration |
- Template :
- To use with Github Pages
- With Netlify
- Documentation
You can find more information about creating the site using the Material Mkdocs Documentation.
In the repository that you cloned, you will find a mkdocs.yml
file. This file allows you to customize your blog. The most important settings to edit are:
site_name
site_description
site_url
(critical): By default, it'shttps://github_username.github.io/repo_name
[^1]
To edit the logo and favicon, first put the chosen files in the assets/logo
directory, and then change logo
and favicon
:
logo: assets/meta/logo_name.png
favicon: assets/meta/favicon.png
- To properly work with SEO, also edit the
extra
withSEO: 'assets/meta/LOGO_SEO.png'
You can also customize:
- Font
- Color scheme, palette, and icons
- Language
Check the documentation for more information
You don't need to touch anything in features
or markdown_extensions
.
The last part of the mkdocs.yml
is a configuration for the hooks
and the template Jinja displaying the list of articles (blog_list.html
).
There are also :
SEO
(string
): Link to your default image displayed by the SEO.comments
(boolean
) : Allow the comments block at the end of the pagegenerate_graph
(boolean
): Generate the [[customization#Graph view|graph view]]attachments
(boolean
): For [[configuration#Blog list (article listing)]] and image in SEO. Change it according to your Obsidian Plugin settings.
The list of articles is configured by the key blog_list
and can take the following parameters :
pagination
(boolean, default: True
): Display a pagination if the list is too long.pagination_message
(boolean, default: True
): Display a message with the number of posts (article/file) in the folder.pagination_translation
(string, default: 'posts in'
): Translation of the pagination's message.no_page_found
(string, default: "No pages found!"
): The text to display if no pages were found.
This part contains the configuration of hooks
, short python scripts that allow to patch some Obsidian parts incompatible with Mkdocs.
You can configure :
- The suppression of the Obsidian's comments (
%% comments %%
):strip_comments: true
- A fix for headings, which adds a
#
to all headings (except the 6th one) because the Mkdocs TOC considers that the H1 is the main heading/title of the file:fix_heading: true
To run the blog locally, you need to install the requirements and run mkdocs serve
.
cd publish_blog pip install -r requirements.txt mkdocs serve
A tip: You can use a conda environment here (or a venv, but I prefer conda). Just use this command:
conda create -n Publisher python=3.11
conda activate Publisher
Run this command just before running pip install
.