50d7c54bdf
* added tutorials page and blog tutorial * proof reading, some language improvements * split blog tutorial into parts and reworked on the basis of comments, improved language, added missing things * + custom slugify function example * +blog tutorial on engagement * + section blog ToC * + instructions for X/FB share buttons and started discussion system * fix: module name `code` shadowed Python standard library module * added What's next section * +blog tutorial engagement part * fix: updated Giscus code snippet * trying multiple tutorials with headings for each group * + basic social cards tutorial * + custom social card tutorial * + estimated time for custom card tutorial * added tutorial sections to nav * fixed typos, removed sponsor icon from level one heading * removed "tutorial" from level one heading * added headings to custom layout example * fixed broken link * fixes after run-through, added links to template repos * added comment for @squidfunk * clarified use of logos, some proof-reading * removed question I left for @squidfunk * clarified relationship between background color and image * added override for the background image * fixed wording and indentation * changed example to be releases, not events * being more specific where to add the last bit of code in the layout --------- Co-authored-by: squidfunk <martin.donath@squidfunk.com>
2.7 KiB
Tutorials
In addition to the basic getting started guides, we offer tutorials that aim to show how you can use Material for MkDocs in different use cases. In contrast to the getting started guides or the reference documentation, the tutorials show the breadth of features available in Material for MkDocs but also within the wider MkDocs ecosystem.
The tutorials guide you through worked examples, so by following them you should gain not only an understanding of how to use Material for MkDocs, but also a template for your own projects. For convenience, these templates are also available as template repositories on GitHub.
The tutorials assume that you have installed either the public version or the Insiders edition of Material for MkDocs and that you have worked through the creating your site setup guide.
Note that where the features we use require the Insiders edition, we mark these with the heart icon: If you are using the public version then you can skip these steps. Sometimes there will be ways of achieving the same goal that differ between the public version and the Insider edition. In that case, we will show them in a tabbed view so you can see one or the other.
!!! note "Feedback wanted!" The tutorials are a recent addition to our documentation and we are still working out what shape they should have in the end. Please contact us if you want to provide feedback.
Note, however, that suggestions should be specific and feasible. We want to
focus on creating more content at the moment, instead of developing a
specific styling or behaviour for the tutorials. If there are worthwhile
improvements that we can make through simple customization then we are happy
to consider those.
Blogs
- Basics (20 min)
covers the basics of setting up a blog, including post metadata. - Navigation, pagination, multiple authors (30 min)
describes how to make it easier for your readers to find content. - Engagement and dissemination (30 min)
walks you through ways of increasing engagement with your content.
:octicons-repo-template-24: Template Repository
Social cards
- Basics (20 min)
shows you how to configure Material for MkDocs to create social cards for your content. - Custom cards (15 min)
shows you how to design your own custom social cards.