Skip to content
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

Convert documentation to mkdocs-material #112

Open
FlorianLudwig opened this issue Apr 27, 2022 · 3 comments
Open

Convert documentation to mkdocs-material #112

FlorianLudwig opened this issue Apr 27, 2022 · 3 comments

Comments

@FlorianLudwig
Copy link
Member

Writing markdown comes a lot easier to me (and it seems others as well) then ReStructuredText. So I suggest converting the docs to markdown and use mkdocs to generate nice looking html docs.

@FlorianLudwig
Copy link
Member Author

@HerrMuellerluedenscheid do you have any objections?

@HerrMuellerluedenscheid
Copy link
Contributor

I also find markdown easier to write. What I don't like about markdown is that it does not support literal includes of other files. That means that examples have to be writen inside an .md file. That means that examples cannot be integrated in CI pipelines which makes puts them at greater risk to become outdated. I mean we don't check examples right now anyway, so it wouldn't change a thing. I'm also not sure though if mkdocs has a way to allow includes of other files inside markdown.
So, I'm ok with changing to markdown. Just wanted to share my thoughts :)

@FlorianLudwig
Copy link
Member Author

FlorianLudwig commented Feb 14, 2023

Including is possible, https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#embedding-external-files

using ASCII scissors cutting a line followed by the name of the file:

--8<-- "filename.ext"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants