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.

Sign up for GitHub

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

Jump to bottom

Maven Site 4 will break code highlight of Markdown source #600

Open
awxiaoxian2020 opened this issue Feb 2, 2024 · 25 comments
Open

Maven Site 4 will break code highlight of Markdown source #600

awxiaoxian2020 opened this issue Feb 2, 2024 · 25 comments
Assignees
@hazendaz

Comments

@awxiaoxian2020
Copy link
Contributor

awxiaoxian2020 commented Feb 2, 2024 •
edited
Loading

repro repo https://github.com/awxiaoxian2020/code-render-bug
master branch is Maven Site 3 with Fluido skin 1
v4 branch is Maven Site 4 with Fluido skin 2.

Open their respective target/site/test.html files in local to see the rendered result.
@awxiaoxian2020 awxiaoxian2020 changed the title Maven Site 4 with Fluido skin 2 will break code highlight of Markdown source Maven Site 4 will break code highlight of Markdown source Feb 2, 2024
@hazendaz
Copy link
Member

hazendaz commented Feb 2, 2024 via email

@awxiaoxian2020
Copy link
Contributor Author

maven-site-3
maven-site-4

@awxiaoxian2020
Copy link
Contributor Author

You can compare MyBatis Site English Content with MyBatis-Spring-Boot-Starter 3.0.2 Site Content, the latter use mybatis-parent 37.

@awxiaoxian2020
Copy link
Contributor Author

I also post a issue at https://issues.apache.org/jira/browse/MSITE-1002

@hazendaz
Copy link
Member

hazendaz commented Feb 3, 2024

Possibly related to https://issues.apache.org/jira/browse/DOXIA-571. Was broken in earlier releases then fixed, possibly history repeating itself.

@hazendaz
Copy link
Member

hazendaz commented Feb 3, 2024

See https://shred.zone/cilla/page/431/fluido-skin-and-markdown-syntax-highlighting.html

Using that, I added this site.xml

<site>
    <skin>
        <groupId>org.apache.maven.skins</groupId>
        <artifactId>maven-fluido-skin</artifactId>
        <version>2.0.0-M8</version>
    </skin>
    <body>
        <head>
          <!-- Workaround for https://issues.apache.org/jira/browse/DOXIA-571 -->
          <![CDATA[<script type="text/javascript">
            $(document).ready(function () {
              $(".language-java").addClass("prettyprint");
              prettyPrint();
            });
          </script>]]>
        </head>

    </body>
</site>

Issue is fixed then. Thanks for opening ticket with maven.

@awxiaoxian2020
Copy link
Contributor Author

awxiaoxian2020 commented Feb 4, 2024 •
edited
Loading

So should we add a workaround like this in mybatis-parent now?

@hazendaz
Copy link
Member

hazendaz commented Feb 4, 2024 via email

@awxiaoxian2020
Copy link
Contributor Author

Maven team have fixed it and could we publish the site to fix this issue?

@hazendaz
Copy link
Member

hazendaz commented Jun 3, 2024

Did they fix it in M14 or M15? M14 was already released here. For M15, will be likely end of the month.

@awxiaoxian2020
Copy link
Contributor Author

I mean, for example we can release mybatis-3 to apply what updated.

@hazendaz
Copy link
Member

hazendaz commented Jun 4, 2024 via email

@awxiaoxian2020
Copy link
Contributor Author

Any update on site branch?

@hazendaz
Copy link
Member

I pushed the site, please check tomorrow or after to see if it updated as expected. I checked just now but its still showing from April and I think there is some delay in it showing up. Let me know what you see. Thanks!

@awxiaoxian2020
Copy link
Contributor Author

It didn't update…

@awxiaoxian2020 awxiaoxian2020 mentioned this issue Jun 29, 2024
Open
@hazendaz
Copy link
Member

hazendaz commented Jul 3, 2024

looking into the issue, no ETA. For whatever reason the site did not upload like expected. I'm checking to see if its because its not a final release. I don't want to release just to get site working but if that is the case, will take some time to do some code cleanups throughout so that the release is more than just fixing the site.

@hazendaz
Copy link
Member

hazendaz commented Aug 4, 2024

Maven didn't actually fix the issue at all. I tried your code again and it still needs the patch I noted to even work. So you may want to ping them again since it doesn't seem they fixed anything. They got rid of a 'div' around the block but prettyprint is no where to be found.

@hazendaz hazendaz self-assigned this Aug 4, 2024
@awxiaoxian2020
Copy link
Contributor Author

apache/maven-site-plugin#210 has upgraded the fluido skin version which is fixing this issue just now. But I don't know when the team will release maven-site-plugin-4.0.0-M17...

@hazendaz
Copy link
Member

hazendaz commented Oct 19, 2024 via email

@hazendaz
Copy link
Member

hazendaz commented Oct 19, 2024 via email

@awxiaoxian2020
Copy link
Contributor Author

Sorry, I forgot fluido is independent in this project. maven should fixed it in 2.0.0-M10. So maybe at least we can just release...

@awxiaoxian2020
Copy link
Contributor Author

I have previewed at local machine. You just need to release the parent-46, we can fix this issue.

@awxiaoxian2020
Copy link
Contributor Author

Hi, @hazendaz When do you release parent-46? 👀

@hazendaz
Copy link
Member

hazendaz commented Dec 2, 2024

This has been released at parent 46. It should start cycling around in a few hours. I'll be away though so maybe @harawata might see and pick those up. If I recall, you are concerned about mybatis core itself. I'm not 100% convenience maven fixed anything. But there were nearly 160 commits or so, so lets give it a shot and see ;)

@hazendaz
Copy link
Member

hazendaz commented Dec 2, 2024

will keep this open until we know for sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hazendaz hazendaz

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hazendaz @awxiaoxian2020