{"repo":"cicirello/javadoc-cleanup","free":true,"listed":false,"github":"https://github.com/cicirello/javadoc-cleanup","clone":"git clone https://github.com/cicirello/javadoc-cleanup.git","description":"Create mobile-friendly documentation sites by post-processing javadocs in GitHub Actions","language":"Python","stars":16,"topics":["github-actions","javadoc","mobile-browsers","documentation","documentation-site","mobile-friendly","java"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"javadoc-cleanup Check out all of our GitHub Actions: https://actions.cicirello.org/ About GitHub Actions :--- :--- Build Status Source Info Support The javadoc-cleanup GitHub action is a utility to tidy up javadocs prior to deployment to an API documentation website, assumed hosted on GitHub Pages. It performs the following functions: Improves mobile browsing experience: It inserts within the of each html file that was generated by javadoc, if not already present. Beginning with Java 16, javadoc properly defines the viewport, whereas prior to Java 16, it does not. Strips out any timestamps inserted by javadoc: The timestamps cause a variety of version control issues for documentation sites maintained in git repositories. Javadoc has an option -notimestamp to direct javadoc not to insert timestamps (which we recommend that you also use). However, at the present time there appears to be a bug (in OpenJDK 11's javadoc, and possibly other versions), where the timestamp is not ommitted in the overview-summary.html generated by javadoc. It is also capable of generating and inserting the canonical URL for each page, of the form . Enables inserting a user-defined block into the head of each javadoc generated page. For example, if you want to insert a link to your site's favicon, or a referrer policy, or really anything else that is valid in the head of an html file. In projects that use the Java Platform Module System (JPMS), javadoc redirects the root index.html to the page of a mod","default_branch":null,"files":null,"tree":[],"storefront":"/r/cicirello","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/cicirello/javadoc-cleanup/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}