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

[Doc] rofi-theme.5 html #2112

Closed
2 tasks done
elig0n opened this issue Mar 6, 2025 · 2 comments
Closed
2 tasks done

[Doc] rofi-theme.5 html #2112

elig0n opened this issue Mar 6, 2025 · 2 comments

Comments

@elig0n
Copy link
Contributor

elig0n commented Mar 6, 2025

Rofi version (rofi -v)

Version: 1.7.5

URL

https://davatorium.github.io/rofi/current/rofi-theme.5/#window

Explain the issue with the documentation, please be verbose.

The html generated documentation for rofi-theme.5 shows the window widget's transparency property possible values as further properties and not as indented values, like in the markdown file


i..e problematic text is:

  • transparency
  • real
  • background
  • screenshot
  • Path

while it should be:

  • transparency
    • real
    • background
    • screenshot
    • Path

Optional fixed text

the markdown is properly indented so probably the file that is generated from it should be regenerated ?

Using wayland display server protocol

  • No, my documentation issue is not about running rofi using the wayland display server protocol

I've checked if the issue exists in the latest stable release

  • Yes, I have checked the problem exists in the latest stable version
@DaveDavenport
Copy link
Collaborator

The manpage renders correctly for me:

Image

It looks like there is a difference in the interpretation of the markdown by the different tools.
Also here it is correctly rendered.

Optional fixed text

the markdown is properly indented so probably the file that is generated from it should be regenerated ?

The description of this issue template field is apparently not clear? Do you have suggestions on how to improve this to avoid confusion?

I pushed a small fix, hopefully this fixes it for mkdocs. We will see in a few minutes.

@DaveDavenport
Copy link
Collaborator

Image

Looks like it worked.. Thanks for the report.

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

No branches or pull requests

2 participants