From 601dc6ef41289d448cfdcedd2600ad2e17e2ab94 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 17 Oct 2023 06:57:48 +0000 Subject: Deployed d3db3ac to dev with MkDocs 1.5.3 and mike 1.1.2 --- dev/blog/2023/10/07/rule/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'dev/blog/2023/10') diff --git a/dev/blog/2023/10/07/rule/index.html b/dev/blog/2023/10/07/rule/index.html index a78a7f04..561ba7cd 100644 --- a/dev/blog/2023/10/07/rule/index.html +++ b/dev/blog/2023/10/07/rule/index.html @@ -1,5 +1,5 @@ Rule 基类已经支持泛型了 - HydroRollCore 核心文档
跳转至

Rule 基类已经支持泛型了⚓︎

Hey there! You're looking at our new blog, built with the brand new built-in blog plugin. With this plugin, you can easily build a blog alongside your documentation or standalone.

Proper support for blogging, as requested by many users over the past few years, was something that was desperately missing from Material for MkDocs' feature set. While everybody agreed that blogging support was a blind spot, it was not obvious whether MkDocs could be extended in a way to allow for blogging as we know it from Jekyll and friends. The built-in blog plugin proves that it is, after all, possible to build a blogging engine on top of MkDocs, in order to create a technical blog alongside your documentation, or as the main thing.

This article explains how to build a standalone blog with Material for MkDocs. If you want to build a blog alongside your documentation, please refer to the plugin's documentation.

Quick start⚓︎

Creating a standalone blog⚓︎

You can bootstrap a new project using the mkdocs executable:

1
mkdocs new .
+">Rule 基类已经支持泛型了 - HydroRollCore 核心文档       
  
  
  
 
  
 
  
 
 
  
 
 
 
 
 
 
  
 
 
 
       
Rule 基类已经支持泛型了⚓︎
 
Hey there! You're looking at our new blog, built with the brand new built-in blog plugin. With this plugin, you can easily build a blog alongside your documentation or standalone.
 
Proper support for blogging, as requested by many users over the past few years, was something that was desperately missing from Material for MkDocs' feature set. While everybody agreed that blogging support was a blind spot, it was not obvious whether MkDocs could be extended in a way to allow for blogging as we know it from Jekyll and friends. The built-in blog plugin proves that it is, after all, possible to build a blogging engine on top of MkDocs, in order to create a technical blog alongside your documentation, or as the main thing.
  
This article explains how to build a standalone blog with Material for MkDocs. If you want to build a blog alongside your documentation, please refer to the plugin's documentation.
 
Quick start⚓︎
 
Creating a standalone blog⚓︎
 
You can bootstrap a new project using the mkdocs executable:
 
1
mkdocs new .
 
 
This will create the following structure:
 
1
 2
 3
@@ -103,4 +103,4 @@
 arcu tincidunt pulvinar. Vestibulum laoreet risus scelerisque porta congue.
 In velit purus, dictum quis neque nec, molestie viverra risus. Nam pellentesque
 tellus id elit ultricies, vel finibus erat cursus.
-
 
     
  1. If you mark a post as a draft, a red marker appears next to the post date on index pages. When the site is built, drafts are not included in the output. This behavior can be changed, e.g. for rendering drafts when building deploy previews.
    2.  
 
When you spin up the live preview server, you should be greeted by your first post! You'll also realize, that archive and category indexes have been automatically generated for you:
 
Blog
 
However, this is just the start. The built-in blog plugin packs a lot of functionality needed in day-to-day blogging. Visit the documentation of the plugin to learn about the following topics:
 
  
 
Additionally, the built-in blog plugin has dozens of configuration options which allow for fine-tuning the output. You can configure post slugs, general behavior and much more.
 
What's next?⚓︎
 
Getting basic blogging support out the door was quite a challenge – the built-in blog plugin is probably the biggest release this year and already packs a lot of functionality. However, Material for MkDocs is used in many different contexts, which is why we'd expect to iterate, as always.
 
Some ideas already proposed by users:
 
     
  •  
    Blog series: Authors should be able to create so called blog series and assign posts to a blog series using simple identifiers. For each post that is part of a series, a list with links to all other posts should be included in the post's content.
     
    •  
  •  
    Author indexes: Besides archive and category indexes, authors should be able to create per-author indexes, which list all posts linked to an author. Additionally, a profile should be created for each author and linked from posts.
     
    •  
  •  
    Social share buttons: It should be easy to share blog posts via social media or other ways. For this reason, it should be possible to automatically include social sharing buttons with each post.
     
    •  
 
What's still missing from the brand new built-in blog plugin? Feel free to share your ideas in the comments. Together, we can build one of the best modern engines for technical blogging!
 
 
  最后更新: 2023-10-07 
 创建日期: 2023-10-07  
 
 
 
  
  
 
 
 
 
         
\ No newline at end of file
+
  1. If you mark a post as a draft, a red marker appears next to the post date on index pages. When the site is built, drafts are not included in the output. This behavior can be changed, e.g. for rendering drafts when building deploy previews.

When you spin up the live preview server, you should be greeted by your first post! You'll also realize, that archive and category indexes have been automatically generated for you:

Blog

However, this is just the start. The built-in blog plugin packs a lot of functionality needed in day-to-day blogging. Visit the documentation of the plugin to learn about the following topics:

Additionally, the built-in blog plugin has dozens of configuration options which allow for fine-tuning the output. You can configure post slugs, general behavior and much more.

What's next?⚓︎

Getting basic blogging support out the door was quite a challenge – the built-in blog plugin is probably the biggest release this year and already packs a lot of functionality. However, Material for MkDocs is used in many different contexts, which is why we'd expect to iterate, as always.

Some ideas already proposed by users:

  • Blog series: Authors should be able to create so called blog series and assign posts to a blog series using simple identifiers. For each post that is part of a series, a list with links to all other posts should be included in the post's content.

  • Author indexes: Besides archive and category indexes, authors should be able to create per-author indexes, which list all posts linked to an author. Additionally, a profile should be created for each author and linked from posts.

  • Social share buttons: It should be easy to share blog posts via social media or other ways. For this reason, it should be possible to automatically include social sharing buttons with each post.

What's still missing from the brand new built-in blog plugin? Feel free to share your ideas in the comments. Together, we can build one of the best modern engines for technical blogging!

最后更新: 2023-10-17
创建日期: 2023-10-17
\ No newline at end of file -- cgit v1.2.3-70-g09d2