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

Design sample #8

Open
silopolis opened this issue Dec 29, 2023 · 4 comments
Open

Design sample #8

silopolis opened this issue Dec 29, 2023 · 4 comments
Assignees

Comments

@silopolis
Copy link

silopolis commented Dec 29, 2023

Hi,

First, thank you for sharing your work on this project as its ancestor looked very promising (seeing the project's documentation PDF showcased) and MkDocs community is still missing a strong and solid solution to this need.

Thanks to your work, I finally managed to generate a PDF ! 🙏

My issue now is that I don't know how to use the original https://github.com/comwes/mkpdfs-design-sample. I tried to clone it and add a design: path/to/mkpdfs-design-sample/report.scss file, but that doesn't seem to work.

We wrote the docs for our DevOps training using MkDocs, and it'd be fantastic if we could generate the document directly without converting to ODF

Bests
J

Edit: oh wait, but it looks like it is already embedded here !? 🤔
I have no idea why my document is generated "unstyled"?

$ pip list | grep mkdocs                                 
mkdocs                                    1.5.3
mkdocs-awesome-pages-plugin               2.9.2
mkdocs-ezglossary-plugin                  1.5.5
mkdocs-git-revision-date-localized-plugin 1.2.1
mkdocs-include-markdown-plugin            6.0.4
mkdocs-kroki-plugin                       0.6.1
mkdocs-macros-plugin                      1.0.5
mkdocs-material                           9.5.3
mkdocs-material-extensions                1.3.1
mkdocs-section-index                      0.3.8
mkdocs-with-pdf                           0.9.3
mkpdfs2-mkdocs                            1.1.1

I'm joining my config file and sample output to hopefully help solving my problem...

Archive.zip

Thanks in advance

@jurgenwigg
Copy link
Owner

Hi! I'll try to take a look at it tomorrow but I don't guarantee that since it's the end of the year ;) for sure I'll investigate this issue in the first week of the new year.

@jurgenwigg
Copy link
Owner

As I've said - I'm taking a look at the issue.

@jurgenwigg
Copy link
Owner

Ok, I've reproduced the issue and found the problem. In the documentation to this package it's written that css file should be provided, not the scss one.

You can try if styling is working with generating example design with design.py script (it requires npm installed in the env and npm python package installed in your python environment). It will generate example report.css.

Please let me know if it worked for you. Example design provided in the linked repository should be compiled to the css file.

This plug-in definitely needs code and documentation upgrade.

@jurgenwigg jurgenwigg self-assigned this Jan 3, 2024
@silopolis
Copy link
Author

hey @jurgenwigg !
First, my very best wishes for the year to come 🙏
Just a quick one to let you know that I'll give this a shot this week as soon as I'm done with first final examination of the training...
Thank you so much for your quick support
TY
J

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