[pmd-commits] [pmd/pmd] db1cc7: [doc] Improve search index
A source code analyzer
                
                Brought to you by:
                
                    adangel,
                    
                
                    juansotuyo
                    
                
            
            
        
        
        
    | 
      
      
      From: Andreas D. <no...@gi...> - 2025-10-24 15:02:48
      
     | 
| Branch: refs/heads/main Home: https://github.com/pmd/pmd Commit: db1cc73bca3c47159841ff1f48059cd3eb311399 https://github.com/pmd/pmd/commit/db1cc73bca3c47159841ff1f48059cd3eb311399 Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: R docs/_data/strings.yml M docs/_includes/topnav.html M docs/_plugins/custom_filters.rb M docs/js/customscripts.js R docs/pages/news/news.html R docs/pages/news/news_archive.html M docs/search.json Log Message: ----------- [doc] Improve search index - split rule names - disable fuzzy search - correctly escape search index - remove unused news.html and news_archive.html Commit: 1e5c40a8578b53970aeae8c871760a91a7de1b22 https://github.com/pmd/pmd/commit/1e5c40a8578b53970aeae8c871760a91a7de1b22 Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M docs/_includes/topnav.html M docs/css/customstyles.css M docs/js/customscripts.js M docs/search.json Log Message: ----------- [doc] Improve search UI - display title and summary - navigation with arrow keys up/down - keyboard shortcut "s" for search - display 20 search results with scrolling Commit: 9185483e63e1dc374b4a67dd4cd9ea2bef9ae752 https://github.com/pmd/pmd/commit/9185483e63e1dc374b4a67dd4cd9ea2bef9ae752 Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M docs/js/customscripts.js Log Message: ----------- [doc] Improve search UI - close search results when clicking somewhere Commit: 59cc68467bbb4c62b63abe3be0af6a4a24f84db0 https://github.com/pmd/pmd/commit/59cc68467bbb4c62b63abe3be0af6a4a24f84db0 Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M docs/_plugins/custom_filters.rb M docs/js/customscripts.js M docs/search.json M pmd-doc/src/main/java/net/sourceforge/pmd/doc/internal/RuleDocGenerator.java M pmd-doc/src/test/resources/expected/sample.md Log Message: ----------- [doc] Display rule descriptions in search - extracts rule descriptions into frontmatter - use rule descriptions as summary for search result - remove exclude configuration from search as it is not excluding data from search.json by key, but by regexing the content... - remove escape_regex again Commit: fb72c09565c69187ef3d14eaef50556bb0e1f629 https://github.com/pmd/pmd/commit/fb72c09565c69187ef3d14eaef50556bb0e1f629 Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M docs/css/customstyles.css Log Message: ----------- [doc] search: Only show scrollbars when needed in results-container Commit: 3e61127d3e09a4e608c684600371d875b71ab00f https://github.com/pmd/pmd/commit/3e61127d3e09a4e608c684600371d875b71ab00f Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M pmd-doc/src/main/java/net/sourceforge/pmd/doc/internal/RuleDocGenerator.java M pmd-doc/src/test/resources/expected/sample.md Log Message: ----------- [doc] For deprecated rules, provide deprecation notice in search result Commit: f329ab38d97d277347bf523f9474d15bc7bea3e2 https://github.com/pmd/pmd/commit/f329ab38d97d277347bf523f9474d15bc7bea3e2 Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M docs/js/customscripts.js Log Message: ----------- [doc] search: avoid losing focus while searching Commit: f614ba1e697aee5fb08b015ec6689ca5dce52f97 https://github.com/pmd/pmd/commit/f614ba1e697aee5fb08b015ec6689ca5dce52f97 Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M docs/js/customscripts.js Log Message: ----------- [doc] search: refactor to not use jquery anymore Commit: 48cbabd7a0263f36286b0a848a10bb7d4878c7a7 https://github.com/pmd/pmd/commit/48cbabd7a0263f36286b0a848a10bb7d4878c7a7 Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M docs/_layouts/default.html M docs/assets/README.md R docs/assets/Simple-Jekyll-Search-1.0.8/dest/jekyll-search.js A docs/assets/Simple-Jekyll-Search-1.14.0/dest/simple-jekyll-search.min.js M docs/js/customscripts.js Log Message: ----------- [doc] search: Update Simple Jekyll Search from 1.0.8 to 1.14.0 Commit: 8f8120f09ab71c09e42fef389eec2b0b2a1abb18 https://github.com/pmd/pmd/commit/8f8120f09ab71c09e42fef389eec2b0b2a1abb18 Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M docs/_layouts/default.html M docs/js/customscripts.js A docs/js/search.js R docs/search.json Log Message: ----------- [doc] Make search working in local mode Move search index into an own js file, that is loaded via <script> and not fetched. This allows to open the documentation locally in a browser and still use the search functionality. Otherwise, you'd need to run a local webserver. Commit: f111bb2feccb6215cf001f7bc1c492088522b26a https://github.com/pmd/pmd/commit/f111bb2feccb6215cf001f7bc1c492088522b26a Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M docs/pages/release_notes.md Log Message: ----------- [doc] Update release notes (#6073) Commit: 8b0adebbaa394d50d868c2e71374378308e1375b https://github.com/pmd/pmd/commit/8b0adebbaa394d50d868c2e71374378308e1375b Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: M docs/_includes/topnav.html Log Message: ----------- [doc] Use emoji variant Commit: aa3901bef8391ea76f416872e9846d0afd52ecec https://github.com/pmd/pmd/commit/aa3901bef8391ea76f416872e9846d0afd52ecec Author: Andreas Dangel <and...@pm...> Date: 2025-10-24 (Fri, 24 Oct 2025) Changed paths: R docs/_data/strings.yml M docs/_includes/topnav.html M docs/_layouts/default.html M docs/_plugins/custom_filters.rb M docs/assets/README.md R docs/assets/Simple-Jekyll-Search-1.0.8/dest/jekyll-search.js A docs/assets/Simple-Jekyll-Search-1.14.0/dest/simple-jekyll-search.min.js M docs/css/customstyles.css M docs/js/customscripts.js A docs/js/search.js R docs/pages/news/news.html R docs/pages/news/news_archive.html M docs/pages/release_notes.md R docs/search.json M pmd-doc/src/main/java/net/sourceforge/pmd/doc/internal/RuleDocGenerator.java M pmd-doc/src/test/resources/expected/sample.md Log Message: ----------- [doc] Search improvements (#6073) Compare: https://github.com/pmd/pmd/compare/9f82b1b45711...aa3901bef839 To unsubscribe from these emails, change your notification settings at https://github.com/pmd/pmd/settings/notifications |