docs(blog): add "Documenting Rust code with Markdown" blog post #8
Conversation
klenkovic
force-pushed
the
blogpost/documenting-rust-code-with-markdown
branch
5 times, most recently
from
d1f91e7 to
9f1b349
Compare
|
As requested, the |
klenkovic
force-pushed
the
blogpost/documenting-rust-code-with-markdown
branch
3 times, most recently
from
bc5f4db to
f1cb14c
Compare
|
As requested, a |
klenkovic
force-pushed
the
blogpost/documenting-rust-code-with-markdown
branch
3 times, most recently
from
8dae903 to
516fb74
Compare
Adds a new blog post on the `GASERI Blog`. The post describes usage of Markdown language while documenting Rust code and usage of `rustdoc` tool to generate a HTML code documentation. It contains a simple guide for the reader to easily try the `rustdoc` tool on his own machine by spinning up a simple Rust web service powered by the `axum` web application framework.
klenkovic
force-pushed
the
blogpost/documenting-rust-code-with-markdown
branch
from
516fb74 to
540391c
Compare
There was a problem hiding this comment.
description: GASERI alumni would be stronger and correct: https://group.miletic.net/en/people/#former-students
| - rust | ||
| - markdown | ||
| - documentation | ||
| - rustdoc |
There was a problem hiding this comment.
I suggest removing rustdoc and axum since these tags are unlikely to be repeated in future posts, but rust should be kept
| authors: | ||
| - klenkovic | ||
| date: 2024-06-01 | ||
| readtime: 15 |
There was a problem hiding this comment.
We can also let Material automatically generate this
| ## Project Setup | ||
|
|
||
| Once you have installed Rust on your system, let's create a new project and install some dependencies that we will need for this to work. | ||
|
|
There was a problem hiding this comment.
Would be nice to have a paragraph here giving a bit of context, i.e. Axum is ... Tokio is ... We'll install them right away.
| @@ -9,3 +9,8 @@ authors: | |||
| description: PhD student | |||
| avatar: https://github.com/mateaturalija.png | |||
| url: https://mateaturalija.github.io/ | |||
| klenkovic: | |||
There was a problem hiding this comment.
I would prefer kristijanlenkovic for consistency
Adds a new blog post on the
GASERI Blog. The post describes usage of Markdown language while documenting Rust code and usage ofrustdoctool to generate a HTML code documentation. It contains a simple guide for the reader to easily try therustdoctool on his own machine by spinning up a simple Rust web service powered by theaxumweb application framework.