search

ImperialCollegeLondon / RSEBlog

https://imperialcollegelondon.github.io/RSEBlog/
0 stars 0 forks source link

Add admonitions and code blocks #40

Closed SaranjeetKaur closed 4 weeks ago

SaranjeetKaur commented 1 month ago

Note that I've added some MkDocs extensions that I think really add to the post and allow us to do some more fun things with the blog. Namely:

Originally posted by @AdrianDAlessandro in https://github.com/ImperialCollegeLondon/RSEBlog/pull/18#pullrequestreview-2231270340

SaranjeetKaur commented 1 month ago

As originally suggested by @AdrianDAlessandro, it will be nice to have instructions on how to use features like admonitions in blog posts. This can be part of the README instructions.

AdrianDAlessandro commented 1 month ago

The Material for MkDocs theme that we use has a number of handy features. We should include links to those docs and make some specific recommendations on ones to use.

Suggestions / ones used so far: