-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
added tutorials page and blog tutorial #7014
Changes from 1 commit
53647ba
6f61627
ab01ac1
c9925f4
e0a5b29
5de5a4f
186c1c1
cc19431
876e7c6
cd15b11
790ff4d
3a3ae8d
4c16ada
5291d41
6a4957d
5b9f720
a41c36b
fa75401
1bff14d
66debda
69501b2
a4bda94
fc26e52
3c9c651
da76ed7
b77de62
c971fd3
4d0b869
9f9299e
2545872
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Tutorials | ||
|
||
In addition to the basic getting started guides, we offer tutorials that aim to | ||
show how Material for MkDocs can be used in different use cases. In contrast to | ||
the getting started guides or the reference documentation, the tutorials show | ||
the breadth of functionality available with Material for MkDocs but also within | ||
the wider MkDocs ecosystem. | ||
|
||
* [Blogs](tutorials/blogs.md) | ||
|
||
## Tutorial Structure | ||
|
||
The tutorials guide you through worked examples, so following them you should | ||
gain not only and understanding of how Material for MkDocs can be used but also | ||
a template for your own projects. For convenience, these templates are also | ||
available as [template repositories on GitHub]. | ||
|
||
<!-- TODO --> | ||
[template repositories on GitHub]: templates.md | ||
|
||
Each tutorial is a single page, so use the Table of Contents navigation to move | ||
between numbered steps. They start by mentioning prerequisites and giving an | ||
overview of the content as well as describing the outcomes. | ||
|
||
### Instructions | ||
|
||
Tutorials contain a mix of explanation, demonstrations, and instructions that you | ||
should follow as you work your way through the individual steps. Those instructions | ||
are shown in the form of admonitions to separate them from the rest of the | ||
tutorial: | ||
|
||
!!! example "Instructions to follow" | ||
|
||
Whenever you see a box like this you know it is time to get hands on and | ||
apply material just covered as well as reflect on how you would it in your | ||
work work. | ||
|
||
### Tips and warnings | ||
|
||
Likewise, helpful tips and warnings appear in boxes of their own: | ||
|
||
!!! tip "A hot tip!" | ||
|
||
Tips look like this... | ||
|
||
!!! warning "Warning!" | ||
|
||
...and warnings like this! | ||
|
||
## Feeback wanted | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Proof-reading required – I spotted several typos, including this one. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Right, I must have written that part before turning on Vale, which would have alerted me to this one. It does not catch problems where a word is correctly spelled but is the wrong word in the context. I guess Grammarly or LanguageTool would find those. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Noh prlblemo! |
||
|
||
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. <!--- TODOD: how? --> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should create a discussion asking for feedback on this tutorial, pin it, and link to that. |
||
|
||
Note, however, that suggestions should be specific and feasible. We want to | ||
focus on creating more content instead of developing a specific styling or | ||
behaviour for the tutorials. If there are worthwhile improvements that can | ||
be made through simple customization we are happy to consider those. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line is reading a bit weird. Especially the "work work" which must be a typo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Jup, as I mentioned in #7014 (comment), this is a draft and not proof-read.