├── static ├── data │ └── .keep ├── images │ ├── homemanageroptionsearch.gif │ ├── home-manager-option-search.png │ └── home-manager-option-search2.png └── opensearch.xml ├── .github ├── FUNDING.yml └── workflows │ └── update.yml ├── .gitignore ├── .gitmodules ├── flake.lock ├── flake.nix ├── README.md ├── CHANGELOG.md ├── scripts └── build_and_parse_hm_options.rb ├── config.yaml └── LICENSE /static/data/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: mipmip 2 | patreon: mipmip919 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .temp.html 2 | .nix-gems 3 | .bundle 4 | result 5 | data/options-release-23.11.json 6 | data/options-master.json 7 | .hugo_build.lock 8 | -------------------------------------------------------------------------------- /static/images/homemanageroptionsearch.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mipmip/home-manager-option-search/HEAD/static/images/homemanageroptionsearch.gif -------------------------------------------------------------------------------- /static/images/home-manager-option-search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mipmip/home-manager-option-search/HEAD/static/images/home-manager-option-search.png -------------------------------------------------------------------------------- /static/images/home-manager-option-search2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mipmip/home-manager-option-search/HEAD/static/images/home-manager-option-search2.png -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "themes/extranix-options-search"] 2 | path = themes/extranix-options-search 3 | url = https://github.com/mipmip/hugo-theme-extranix-options-search 4 | -------------------------------------------------------------------------------- /static/opensearch.xml: -------------------------------------------------------------------------------- 1 | 3 | Home Manager - Options Search 4 | Find home manager options quickly. 5 | UTF-8 6 | https://home-manager-options.extranix.com/images/favicon.png 7 | 8 | https://home-manager-options.extranix.com/ 9 | 10 | -------------------------------------------------------------------------------- /flake.lock: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": { 3 | "nixpkgs": { 4 | "locked": { 5 | "lastModified": 1723637854, 6 | "narHash": "sha256-med8+5DSWa2UnOqtdICndjDAEjxr5D7zaIiK4pn0Q7c=", 7 | "owner": "NixOS", 8 | "repo": "nixpkgs", 9 | "rev": "c3aa7b8938b17aebd2deecf7be0636000d62a2b9", 10 | "type": "github" 11 | }, 12 | "original": { 13 | "owner": "NixOS", 14 | "ref": "nixos-unstable", 15 | "repo": "nixpkgs", 16 | "type": "github" 17 | } 18 | }, 19 | "root": { 20 | "inputs": { 21 | "nixpkgs": "nixpkgs" 22 | } 23 | } 24 | }, 25 | "root": "root", 26 | "version": 7 27 | } 28 | -------------------------------------------------------------------------------- /flake.nix: -------------------------------------------------------------------------------- 1 | { 2 | description = "Home Manager option search static website generator"; 3 | 4 | inputs = { 5 | nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; 6 | }; 7 | 8 | outputs = { self, nixpkgs, ... }: 9 | let 10 | forAllSystems = nixpkgs.lib.genAttrs [ "x86_64-linux" ]; 11 | pkgsForSystem = system: (import nixpkgs { inherit system; }); 12 | in 13 | { 14 | packages = forAllSystems (system: 15 | let 16 | pkgs = (pkgsForSystem system); 17 | in 18 | { 19 | default = pkgs.runCommand "public" {} '' 20 | cd ${./.} 21 | ${pkgs.hugo}/bin/hugo --noBuildLock -d $out 22 | ''; 23 | }); 24 | 25 | devShells = forAllSystems (system: { 26 | default = (pkgsForSystem system).mkShell { 27 | buildInputs = with (pkgsForSystem system); [ 28 | hugo 29 | ruby 30 | ]; 31 | }; 32 | }); 33 | }; 34 | } 35 | -------------------------------------------------------------------------------- /.github/workflows/update.yml: -------------------------------------------------------------------------------- 1 | name: "parse and deploy" 2 | on: 3 | schedule: 4 | - cron: '05 4 * * *' 5 | push: 6 | 7 | jobs: 8 | build: 9 | runs-on: ubuntu-latest 10 | name: parse options and create search 11 | steps: 12 | 13 | - uses: actions/checkout@v4 14 | with: 15 | submodules: recursive 16 | 17 | - uses: DeterminateSystems/nix-installer-action@main 18 | - uses: DeterminateSystems/magic-nix-cache-action@main 19 | 20 | - name: extract-options-master (unstable) 21 | run: ./scripts/build_and_parse_hm_options.rb 22 | 23 | - name: update gitignore 24 | run: echo result > .gitignore 25 | 26 | - name: extract-options-release-25.11 (stable) 27 | env: 28 | HM_RELEASE: release-25.11 29 | run: ./scripts/build_and_parse_hm_options.rb 30 | 31 | - name: extract-options-release-25.05 (old-stable) 32 | env: 33 | HM_RELEASE: release-25.05 34 | run: ./scripts/build_and_parse_hm_options.rb 35 | 36 | - name: Build Hugo 37 | run: nix run nixpkgs#hugo -- --minify 38 | 39 | - name: Deploy 40 | uses: peaceiris/actions-gh-pages@v3 41 | with: 42 | github_token: ${{ secrets.GITHUB_TOKEN }} 43 | publish_branch: pages-${{ github.ref_name }} 44 | publish_dir: ./public 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Home Manager Options Search 2 | 3 | ## Home Manager Options Search has moved 4 | 5 | The new location is HOME-MANAGER-OPTIONS.EXTRANIX.COM 6 | 7 | ## Please update your bookmarks 8 | 9 | Find [home manager](https://github.com/nix-community/home-manager) options quickly. 10 | 11 | ![](static/images/homemanageroptionsearch.gif) 12 | 13 | 14 | ## Maintainers Notes 15 | 16 | After a new NixOS and Home Manager release, update the release info in the Hugo 17 | config: 18 | 19 | Edit `config.yaml`, and update the following... 20 | 21 | ```yaml 22 | params: 23 | release_current_stable: release-25.05 24 | releases: 25 | - name: unstable 26 | value: master 27 | - name: 25.11 (stable) 28 | value: release-25.11 29 | - name: 25.05 30 | value: release-25.05 31 | - name: 24.11 32 | value: release-24.11 33 | - name: 24.05 34 | value: release-24.05 35 | - name: 23.11 36 | value: release-23.11 37 | - name: 23.05 38 | value: release-23.05 39 | - name: 22.11 40 | value: release-22.11 41 | ``` 42 | 43 | This file is used by ./scripts/build_and_parse_hm_options.rb and by Hugo when 44 | generating a new website version. 45 | 46 | 47 | ## Contribute 48 | 49 | - Please use the issue tracker or fork this site for PR's 50 | 51 | ## Credits 52 | 53 | - Powered by the [Nix Community](https://nix-community.org/) 54 | - [JS Search](https://github.com/bvaughn/js-search), efficient, client-side search library for JavaScript and JSON objects 55 | - Header inspired by the [DocDock](https://docdock.vjeantet.fr/) Hugo Theme. 56 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # CHANGELOG 2 | 3 | ## Version 1.6 4 | 5 | - fix behvaiour of enter key (thanks to github.com/ian-h-chamberlain) 6 | - default to stable release 7 | - improve build_and_parse_hm_options script 8 | - central stable version configuration 9 | - add 24.05 as latest stable version 10 | 11 | ## Version 1.5 12 | 13 | - hugofication 14 | - keyboard (tab) navigation (thanks to github.com/hallundbaek) 15 | - better result sorting (thanks to github.com/hallundbaek) 16 | - style improvements 17 | - native options export 18 | - improve example and descriptions layout 19 | - move to extranix.com 20 | - prepare ethical ads 21 | 22 | ## Version 1.4 23 | 24 | - featuring dark mode 25 | - fix parsing bug causing wrong search results 26 | 27 | ## Version 1.3 28 | 29 | - new logo 30 | - remove animations 31 | - sticky search field 32 | - sticky table headers 33 | - sticky footer 34 | - hide advanced search options 35 | - change menu items 36 | - multiple minor layout changes 37 | 38 | ## Version 1.2 39 | 40 | - preserve links in declared_by 41 | - add favicon 42 | - show example when in `` element 43 | - remove proto from title 44 | - github action parser working 45 | 46 | ## Version 1.1 47 | 48 | - [x] hover plus handicon row 49 | - [x] search improvements 50 | - [x] allow enter 51 | - [x] read url query string 52 | 53 | ## Version 1 54 | 55 | - [x] finish nokogiri 56 | - [x] write to json 57 | - [x] make search front end 58 | - [x] write last updated 59 | - [x] reference to home manager and appendix page 60 | - [x] github actions 61 | - [x] bug filtered out 62 | - [x] improve style 63 | - [x] cleanup/reorganize 64 | - [x] logo 65 | - [x] footer/header like the NUR 66 | - [x] stats 67 | - [x] onclick show complete listing 68 | 69 | 70 | -------------------------------------------------------------------------------- /scripts/build_and_parse_hm_options.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | # Copyright 2024 Pim Snel 4 | # License: MIT 5 | 6 | require 'json' 7 | require 'pp' 8 | require 'yaml' 9 | 10 | def isLiteralExpression(val, key) 11 | if val.key? key and val[key].instance_of? Hash and val[key].key? "_type" and val[key]['_type'] == 'literalExpression' 12 | true 13 | else 14 | false 15 | end 16 | end 17 | 18 | def getValFor(val, key) 19 | if isLiteralExpression(val, key) 20 | val[key]['text'] 21 | elsif val.key? key 22 | val[key] 23 | else 24 | "" 25 | end 26 | end 27 | 28 | def parseVal(val) 29 | val['example'] = getValFor(val, 'example') 30 | val['default'] = getValFor(val, 'default') 31 | 32 | val 33 | end 34 | 35 | in_file_conf = File.read("./config.yaml") 36 | config = YAML.load(in_file_conf) 37 | 38 | if not ENV['HM_RELEASE'] 39 | ENV['HM_RELEASE'] = "master" 40 | elsif ENV['HM_RELEASE'] == "stable" 41 | ENV['HM_RELEASE'] = config['params']['release_current_stable'] 42 | end 43 | 44 | puts "Cleanup and Building Home Manager options from #{ENV['HM_RELEASE']}" 45 | 46 | `rm -Rf result` 47 | `nix build github:nix-community/home-manager/${HM_RELEASE}#docs-json --no-write-lock-file` 48 | `rm -f ./data/options-${HM_RELEASE}.json` 49 | 50 | in_file = File.read("./result/share/doc/home-manager/options.json") 51 | parsed = JSON.parse(in_file) 52 | 53 | options_arr = [] 54 | parsed.each do | name, val | 55 | 56 | next if name == '_module.args' 57 | 58 | val['title'] = name 59 | val = parseVal(val) 60 | 61 | options_arr << val 62 | end 63 | 64 | outobj = {} 65 | time = Time.new 66 | outobj["last_update"] = time.utc.strftime("%B %d, %Y at %k:%M UTC") 67 | outobj["options"] = options_arr 68 | 69 | filename = "static/data/options-#{ENV['HM_RELEASE']}.json" 70 | 71 | File.open(filename,"w") do |f| 72 | f.write(outobj.to_json) 73 | end 74 | 75 | puts "Finished parsing home manager options." 76 | -------------------------------------------------------------------------------- /config.yaml: -------------------------------------------------------------------------------- 1 | baseURL: https://home-manager-options.extranix.com/ 2 | languageCode: en-us 3 | title: Home Manager - Option Search 4 | theme: extranix-options-search 5 | 6 | params: 7 | 8 | release_current_stable: release-25.11 9 | releases: 10 | - name: unstable 11 | value: master 12 | - name: 25.11 (stable) 13 | value: release-25.11 14 | - name: 25.05 15 | value: release-25.05 16 | - name: 24.11 17 | value: release-24.11 18 | - name: 24.05 19 | value: release-24.05 20 | - name: 23.11 21 | value: release-23.11 22 | - name: 23.05 23 | value: release-23.05 24 | - name: 22.11 25 | value: release-22.11 26 | 27 | release_switch_title: Home Manager Release 28 | 29 | custom_head_scripts: | 30 | 31 | 32 | 33 | custom_header_tags:
34 | 35 | footer_credits_line: | 36 | Powered by the Nix Community | 37 | Credits | 38 | Home Manager Documentation 39 | 40 | footer_copyright_line: | 41 | Made with ❤️ by Pim Snel - © 2022-2024 42 | 43 | logo: images/home-manager-option-search2.png 44 | 45 | github: 46 | repo: home-manager-option-search 47 | user: mipmip 48 | show_count: true 49 | show_text: true 50 | 51 | main_menu: 52 | 53 | - name: HM Documentation 54 | url: https://nix-community.github.io/home-manager/ 55 | icon_class: fa fa-book 56 | 57 | - name: Source 58 | url: https://github.com/mipmip/home-manager-option-search 59 | icon_class: fa fa-github 60 | 61 | markup: 62 | goldmark: 63 | renderer: 64 | unsafe: true 65 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------