diff --git a/info.plist b/info.plist index 0832ee2..1869520 100644 --- a/info.plist +++ b/info.plist @@ -588,7 +588,7 @@ escaping 0 keyword - {var:keyword_01}||{var:keyword_02}||{var:keyword_03}||{var:keyword_04}||{var:keyword_05}||{var:keyword_06}||{var:keyword_07}||{var:keyword_08}||{var:keyword_09}||{var:keyword_10}||{var:keyword_11}||{var:keyword_12}||{var:keyword_13}||{var:keyword_14}||{var:keyword_15}||{var:keyword_16}||{var:keyword_17}||{var:keyword_18}||{var:keyword_19}||{var:keyword_20}||{var:keyword_21}||{var:keyword_22}||{var:keyword_23}||{var:keyword_24}||{var:keyword_25}||{var:keyword_26}||{var:keyword_27}||{var:keyword_28}||{var:keyword_29}||{var:keyword_30}||{var:keyword_31}||{var:keyword_32}||{var:keyword_33}||{var:keyword_34}||{var:keyword_35}||{var:keyword_36}||{var:keyword_37}||{var:keyword_38}||{var:keyword_39}||{var:keyword_40} + {var:shared_devdocs_prefix}{var:keyword_01}||{var:shared_devdocs_prefix}{var:keyword_02}||{var:shared_devdocs_prefix}{var:keyword_03}||{var:shared_devdocs_prefix}{var:keyword_04}||{var:shared_devdocs_prefix}{var:keyword_05}||{var:shared_devdocs_prefix}{var:keyword_06}||{var:shared_devdocs_prefix}{var:keyword_07}||{var:shared_devdocs_prefix}{var:keyword_08}||{var:shared_devdocs_prefix}{var:keyword_09}||{var:shared_devdocs_prefix}{var:keyword_10}||{var:shared_devdocs_prefix}{var:keyword_11}||{var:shared_devdocs_prefix}{var:keyword_12}||{var:shared_devdocs_prefix}{var:keyword_13}||{var:shared_devdocs_prefix}{var:keyword_14}||{var:shared_devdocs_prefix}{var:keyword_15}||{var:shared_devdocs_prefix}{var:keyword_16}||{var:shared_devdocs_prefix}{var:keyword_17}||{var:shared_devdocs_prefix}{var:keyword_18}||{var:shared_devdocs_prefix}{var:keyword_19}||{var:shared_devdocs_prefix}{var:keyword_20}||{var:shared_devdocs_prefix}{var:keyword_21}||{var:shared_devdocs_prefix}{var:keyword_22}||{var:shared_devdocs_prefix}{var:keyword_23}||{var:shared_devdocs_prefix}{var:keyword_24}||{var:shared_devdocs_prefix}{var:keyword_25}||{var:shared_devdocs_prefix}{var:keyword_26}||{var:shared_devdocs_prefix}{var:keyword_27}||{var:shared_devdocs_prefix}{var:keyword_28}||{var:shared_devdocs_prefix}{var:keyword_29}||{var:shared_devdocs_prefix}{var:keyword_30}||{var:shared_devdocs_prefix}{var:keyword_31}||{var:shared_devdocs_prefix}{var:keyword_32}||{var:shared_devdocs_prefix}{var:keyword_33}||{var:shared_devdocs_prefix}{var:keyword_34}||{var:shared_devdocs_prefix}{var:keyword_35}||{var:shared_devdocs_prefix}{var:keyword_36}||{var:shared_devdocs_prefix}{var:keyword_37}||{var:shared_devdocs_prefix}{var:keyword_38}||{var:shared_devdocs_prefix}{var:keyword_39}||{var:shared_devdocs_prefix}{var:keyword_40} queuedelaycustom 3 queuedelayimmediatelyinitially @@ -1747,13 +1747,7 @@ curl -sL "https://raw.githubusercontent.com/chrisgrieser/alfred-docs-searches/ma readme - ## Recent changes -This workflow's `man` and `cani` search have been deprecated, since they are now -available via DevDocs. To use them, enable them in the list of docs to the right. - ---- - -## DevDocs + ## DevDocs Enable the devdocs you want to use in the workflow configuration. The enabled devdocs are searched by using the name as keyword, for example `haskell foobar` to search the Haskell DevDocs for "foobar." @@ -1816,7 +1810,7 @@ the directory `./devdocs/icons/{keyword}.png`. PRs are welcome. - Get the Uniform Type Identifier (UTI) of a selected file via the [Universal Action](https://www.alfredapp.com/help/workflows/triggers/universal-actions/). -## Reload Caches +## Reload caches In case of a recent change to a documentation site, you can manually trigger refreshing the cache via the Alfred keyword `:docs-reload`. @@ -11065,6 +11059,7 @@ Workflow created by [Chris Grieser](https://chris-grieser.de/). description label type popupbutton variable keyword_40 config default required trim verticalsize 3 description one per line; see to the right for explanations label pinned devdocs versions type textarea variable select_versions config default required text description Only available for a few sites. PRs welcome. label open at original type checkbox variable use_source_page_if_available + config default placeholder required trim description Shared keyword prefix for DevDocs searches. If set to "dd" , will search the bash documentation via "ddbash" instead of "bash". Leave empty to not use any such prefix. label DevDocs prefix type textfield variable shared_devdocs_prefix version 2.17.2 diff --git a/scripts/devdocs/search-devdocs.js b/scripts/devdocs/search-devdocs.js index 5c6ae5c..81e600c 100755 --- a/scripts/devdocs/search-devdocs.js +++ b/scripts/devdocs/search-devdocs.js @@ -76,9 +76,10 @@ function readFile(path) { // biome-ignore lint/correctness/noUnusedVariables: Alfred run function run() { - const keyword = $.getenv("alfred_workflow_keyword"); - // biome-ignore lint/suspicious/noConsole: - // biome-ignore lint/suspicious/noConsoleLog: + const prefix = $.getenv("shared_devdocs_prefix"); + const keyword = $.getenv("alfred_workflow_keyword").substring(prefix.length); + + // biome-ignore lint/suspicious/noConsole: intentional console.log("keyword:", keyword); ensureCacheFolderExists(); diff --git a/scripts/devdocs/update-devdocs.mjs b/scripts/devdocs/update-devdocs.mjs index 6ff3131..0858e1d 100755 --- a/scripts/devdocs/update-devdocs.mjs +++ b/scripts/devdocs/update-devdocs.mjs @@ -20,8 +20,8 @@ const aliases = { browser_support_tables: "cani", matplotlib: "plt", // conventional abbreviation: https://docs.astral.sh/ruff/settings/#lint_flake8-import-conventions_aliases - // PENDING https://github.com/freeCodeCamp/devdocs/issues/2210 - // devdocs aliases https://devdocs.io/help#aliases + // update this once this PR is merged active: https://github.com/freeCodeCamp/devdocs/pull/2344 + // check via: curl -sL "https://devdocs.io/docs.json" | grep "alias" | grep -v "null" ; curl -sL "https://documents.devdocs.io/docs.json" | grep "alias" | grep -v "null" angular: "ng", angularjs: "ng", // removed `.` backbone: "bb", // removed `.js` @@ -61,6 +61,7 @@ const aliases = { const extraWorkflowConfig = [ " config default required trim verticalsize 3 description one per line; see to the right for explanations label pinned devdocs versions type textarea variable select_versions ", " config default required text description Only available for a few sites. PRs welcome. label open at original type checkbox variable use_source_page_if_available ", + ' config default placeholder required trim description Shared keyword prefix for DevDocs searches. If set to "dd" , will search the bash documentation via "ddbash" instead of "bash". Leave empty to not use any such prefix. label DevDocs prefix type textfield variable shared_devdocs_prefix ', ]; async function run() {