Coder Social home page Coder Social logo

z-shell / wiki Goto Github PK

View Code? Open in Web Editor NEW
15.0 2.0 8.0 50.78 MB

✨ Z-Shell Wiki

Home Page: https://wiki.zshell.dev

License: GNU General Public License v3.0

Dockerfile 0.09% JavaScript 0.03% TypeScript 2.44% CSS 2.05% Shell 0.47% MDX 94.92%
zshell wiki documentation docusaurus docusaurus-documentation

wiki's Introduction

Localized badge Version Project License VIM

Follow Up Card Metrics Card
Pagespeed Card

Asciinema Preview


Project assistance

If you want to say thank you or/and support the active development.

- Add a GitHub Star to the project, and follow Z-Shell organization.

- Write interesting articles about the project on:
Dev.to, Medium.com, Hacker News, Community.ops.io, Reddit, Twitter or your blog. Let us know so can share your post, especially if it's in other languages or some interesting zshrc configurations

Participate in the community by showing the interest to the project, as it may bring us together, then great things may happen. If you would like to participate, but are not sure about what and how - do not hesitate to contact us so we can discuss the situation 👍. We've all been there, we all had to start from something - together is much easier, just need to do the first step 🚀.


Security

- Z-Shell follows good practices of security, but 100% security cannot be assured.

- Z-Shell is provided "as is" without any warranty. Use at your own risk.

- For more information and to report security issues, please refer to our security documentation.


Authors & contributors

Check the list of authors and contributors in this repository and also all other repositories under Z-Shell organization. We will inlclude all showning the interest or dedicated their time to take a part.

wiki's People

Contributors

0xmrtt avatar aabur avatar callistachang avatar codefactor-io[bot] avatar daudix avatar deepsource-autofix[bot] avatar dependabot[bot] avatar digital-teams avatar github-actions[bot] avatar imgbot[bot] avatar meinzer1899 avatar metebyte avatar nakayama900 avatar renovate-bot avatar renovate[bot] avatar signed-log avatar slaecker avatar ss-o avatar tru2dagame avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

wiki's Issues

docs: add more informations in CONTRIBUTING

Description

When you go to CONTRIBUTING, you only get basic about the project license and membership. I think that it would be great to add a section which explain how to contribute or add links of useful information like STYLEGUIDE, GUIDELINES, etc

Self-service

  • I'd be willing to address this documentation request myself.
git fetch origin
git checkout 74-docs-add-more-informations-in-contributing

docs: update matrix link

Which locale the issue is related?

No response

Have you read the Contributing Guidelines?

Description

Currently, the matrix link point to the gitter room. It would be better to point to the pure matrix room.

#zshell:matrix.org

Self-service

  • I'd be willing to address this documentation request myself.

docs: Possible issue with LS_COLORS documentation

Which locale the issue is related?

{"label"=>"English"}

Have you read the Contributing Guidelines?

Description

I used the following snippet found in https://wiki.zshell.dev/docs/guides/syntax/standard#ls_colors to set up LS_COLORS in my .zshrc file:

zi ice atclone'dircolors -b LS_COLORS > clrs.zsh' \
  atpull'%atclone' pick"clrs.zsh" nocompile'!' \
  atload'zstyle ":completion:*" list-colors “${(s.:.)LS_COLORS}”'
zi light trapd00r/LS_COLORS

However, it clashed with usage of https://github.com/Aloxaf/fzf-tab, giving the error "bad set of key/value pairs for associative array". I found the answer on this issue: Aloxaf/fzf-tab#100; I removed the surrounding {(s.:.)LS_COLORS} to remove the error:

zi ice atclone'dircolors -b LS_COLORS > clrs.zsh' \
  atpull'%atclone' pick"clrs.zsh" nocompile'!' \
  atload'zstyle ":completion:*" list-colors ${(s.:.)LS_COLORS}'
zi light trapd00r/LS_COLORS

Can I propose to update the docs to remove the surrounding {(s.:.)LS_COLORS} to increase compatibility with other plugins?

Thanks!

Self-service

  • I'd be willing to address this documentation request myself.

[docs]: Algolia Search

Many users almost certainly use at least one of YouTube, Amazon, and Facebook. An essential feature that these big websites share is excellent search. The reason they have a great hunt is that they have hundreds or thousands of people working on it full-time.

Because our users are constantly exposed to great searches on these platforms, they expect to find it on every site and application they use. But we are not a search company: it doesn’t make sense to hire a dedicated team of developers to reinvent search.

Algolia provides software and tools to help you implement efficient, flexible, and insightful searches on sites, applications, and our wiki.

Also, it follows "OpenSearch" specifications which allow to integrate it into almost any of the current popular browsers, applications, or even from the terminal/shell programs/scripts. Based on what content reaches users, on how they try to find it helps to organize content better, to ensure important content reaches users fast and accurately.

All the above makes absolute sense to implement, document, and share with fellow developers.

📢 Link Checker Report

Summary

Status Count
🔍 Total 825
✅ Successful 645
⏳ Timeouts 2
🔀 Redirected 0
👻 Excluded 174
❓ Unknown 0
🚫 Errors 4

Errors per input

Errors in src/pages/legal/PRIVACY.md

Errors in .github/README.md

Errors in community/gallery/collection/02_completions.mdx

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Preset is invalid JSON (local>z-shell/.github:renovate-config)

docs: add `for` + `turbo` syntax to the gallery of invocation

Which locale the issue is related?

No response

Have you read the Contributing Guidelines?

Description

There is currently only two syntax in the gallery of invocation: with for and without for. Zi support a third syntax : turbo mode + for. So, we can add turbo-mode + for syntax

Self-service

  • I'd be willing to address this documentation request myself.
git fetch origin
git checkout 73-docs-add-for-+-turbo-syntax-to-the-gallery-of-invocation

[ci]: dependency dashboard

Z-Shell | Renovate Preset

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

  • Update dependency @mdx-js/react to v2
  • Update react monorepo to v18 (react, react-dom)
  • Update remark monorepo (rehype-katex, remark-math)
  • Lock file maintenance

Detected dependencies

dockerfile
.devcontainer/Dockerfile
  • mcr.microsoft.com/vscode/devcontainers/javascript-node 0-16-bullseye
github-actions
.github/workflows/ci-perf.yml
  • actions/checkout v3
  • pnpm/action-setup v2.2.2
  • actions/setup-node v3
  • preactjs/compressed-size-action v2
  • actions/checkout v3
  • pnpm/action-setup v2.2.2
  • actions/setup-node v3
.github/workflows/codeql.yml
  • actions/checkout v3
  • github/codeql-action v2
  • github/codeql-action v2
  • github/codeql-action v2
.github/workflows/comment-rebase.yml
  • actions/checkout v3
  • cirrus-actions/rebase 1.7
.github/workflows/crowdin-download.yml
  • actions/checkout v3
  • crowdin/github-action 1.4.11
.github/workflows/crowdin-upload.yml
  • actions/checkout v3
  • crowdin/github-action 1.4.11
.github/workflows/dependency-review.yml
  • actions/checkout v3
  • actions/dependency-review-action v2
.github/workflows/labeler.yml
  • actions/labeler v4
.github/workflows/lock.yml
  • dessant/lock-threads v3
.github/workflows/pr-labels.yml
  • jesusvasquez333/verify-pr-label-action v1.4.0
.github/workflows/stale.yml
  • actions/stale v5
npm
package.json
  • @crowdin/cli 3.7.9
  • @docusaurus/core canary
  • @docusaurus/plugin-ideal-image canary
  • @docusaurus/plugin-pwa canary
  • @docusaurus/preset-classic canary
  • @docusaurus/theme-common canary
  • @loadable/babel-plugin 5.13.2
  • @loadable/component 5.15.2
  • @mdx-js/react 1.6.22
  • asciinema-player 3.0.1
  • clsx 1.2.1
  • husky 8.0.1
  • prism-react-renderer 1.3.5
  • raw-loader 4.0.2
  • react 17.0.2
  • react-dom 17.0.2
  • react-spinners 0.13.4
  • rehype-katex 5.0.0
  • remark-math 3.0.1
  • @cloudflare/workers-types 3.14.1
  • @docusaurus/eslint-plugin canary
  • @docusaurus/module-type-aliases canary
  • @docusaurus/types canary
  • @types/node 18.0.6
  • @typescript-eslint/eslint-plugin 5.32.0
  • @typescript-eslint/parser 5.32.0
  • eslint 8.21.0
  • eslint-config-airbnb 19.0.4
  • eslint-config-prettier 8.5.0
  • eslint-plugin-import 2.26.0
  • eslint-plugin-jsx-a11y 6.6.1
  • eslint-plugin-react 7.30.1
  • eslint-plugin-react-hooks 4.6.0
  • lint-staged 13.0.3
  • prettier 2.7.1
  • stylelint 14.9.1
  • stylelint-config-prettier 9.0.3
  • stylelint-config-standard 26.0.0
  • stylelint-csstree-validator 2.0.0
  • typescript 4.7.4
  • node >=16
  • pnpm >=7
  • pnpm 7.8.0

  • Check this box to trigger a request for Renovate to run again on this repository

📢 Link Checker Report

Summary

Status Count
🔍 Total 487
✅ Successful 473
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 9
❓ Unknown 0
🚫 Errors 5

Errors per input

Errors in community/gallery/collection/02_completions.mdx

Errors in community/gallery/collection/04_snippets.mdx

Errors in ecosystem/plugins/f-sy-h.mdx

Errors in docs/getting_started/03_migration.md

Full Github Actions output

Dependency Dashboard

Z-Shell | Renovate Preset

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

  • fix(deps): update dependency @mdx-js/react to v2

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

Detected dependencies

dockerfile
.devcontainer/Dockerfile
  • mcr.microsoft.com/vscode/devcontainers/javascript-node 0-18-bullseye
github-actions
.github/workflows/ci-perf.yml
  • actions/checkout v3.4.0
  • pnpm/action-setup v2.2.4
  • actions/setup-node v3.6.0
  • preactjs/compressed-size-action v2
  • actions/checkout v3.4.0
  • pnpm/action-setup v2.2.4
  • actions/setup-node v3.6.0
.github/workflows/codeql.yml
  • actions/checkout v3
  • github/codeql-action v2
  • github/codeql-action v2
  • github/codeql-action v2
.github/workflows/comment-rebase.yml
  • actions/checkout v3.4.0
.github/workflows/crowdin-download.yml
  • actions/checkout v3
  • crowdin/github-action v1.7.1
.github/workflows/crowdin-upload.yml
  • actions/checkout v3
  • crowdin/github-action v1.7.1
.github/workflows/dependency-review.yml
  • actions/checkout v3
  • actions/dependency-review-action v3
.github/workflows/labeler.yml
  • actions/labeler v4.0.3
.github/workflows/lock.yml
  • dessant/lock-threads v4
.github/workflows/lychee.yml
  • actions/checkout v3.3.0
  • actions/cache v3
  • lycheeverse/lychee-action 9ace499fe66cee282a29eaa628fdac2c72fa087f
  • peter-evans/create-issue-from-file v4
.github/workflows/pages-deployment.yaml
  • actions/checkout v3.4.0
  • pnpm/action-setup v2.2.4
  • actions/setup-node v3.6.0
  • cloudflare/pages-action v1.4.1
.github/workflows/rclone-action.yml
  • actions/checkout v3
.github/workflows/stale.yml
  • actions/stale v7.0.0
npm
package.json
  • @docusaurus/core 2.3.1
  • @docusaurus/plugin-ideal-image 2.3.1
  • @docusaurus/plugin-pwa 2.3.1
  • @docusaurus/preset-classic 2.3.1
  • @docusaurus/theme-mermaid 2.3.1
  • @loadable/component 5.15.3
  • @mdx-js/react 1.6.22
  • asciinema-player 3.2.0
  • clsx 1.2.1
  • prism-react-renderer 1.3.5
  • react 18.2.0
  • react-dom 18.2.0
  • react-spinners 0.13.8
  • @crowdin/cli ^3.10.1
  • @docusaurus/eslint-plugin ^2.3.1
  • @docusaurus/module-type-aliases ^2.3.1
  • @docusaurus/types ^2.3.1
  • @trunkio/launcher ^1.2.3
  • @types/node ^18.15.3
  • @types/react ^18.0.28
  • @typescript-eslint/eslint-plugin ^5.55.0
  • @typescript-eslint/parser ^5.55.0
  • eslint ^8.36.0
  • eslint-config-prettier ^8.7.0
  • eslint-config-standard-with-typescript ^34.0.1
  • eslint-import-resolver-typescript ^3.5.3
  • eslint-plugin-import ^2.27.5
  • eslint-plugin-n ^15.6.1
  • eslint-plugin-promise ^6.1.1
  • eslint-plugin-react ^7.32.2
  • eslint-plugin-react-hooks ^4.6.0
  • stylelint ^15.3.0
  • stylelint-color-format ^1.1.0
  • stylelint-config-prettier ^9.0.5
  • stylelint-config-recess-order ^4.0.0
  • stylelint-config-standard ^30.0.1
  • stylelint-csstree-validator ^2.1.0
  • typescript 5.0.2
  • node >=16.14
  • pnpm 7.29.3

  • Check this box to trigger a request for Renovate to run again on this repository

📊 Dependency Dashboard

Z-Shell | Renovate Preset

Repository problems

These problems occurred while renovating this repository. View logs.

  • WARN: Unable to read vulnerability information

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

  • chore(deps): update mcr.microsoft.com/vscode/devcontainers/javascript-node docker tag to v1

Detected dependencies

dockerfile
.devcontainer/Dockerfile
  • mcr.microsoft.com/vscode/devcontainers/javascript-node 0-18-bullseye
github-actions
.github/workflows/argos.yml
  • actions/checkout v4
  • pnpm/action-setup v2.4.0
  • actions/setup-node v4.0.0
.github/workflows/ci-perf.yml
  • actions/checkout v4
  • pnpm/action-setup v2.4.0
  • actions/setup-node v4.0.0
  • preactjs/compressed-size-action v2
  • actions/checkout v4
  • pnpm/action-setup v2.4.0
  • actions/setup-node v4.0.0
.github/workflows/codeql.yml
  • actions/checkout v4
  • github/codeql-action v2
  • github/codeql-action v2
  • github/codeql-action v2
.github/workflows/comment-rebase.yml
  • actions/checkout v4
  • z-shell/.github v1.0.8
.github/workflows/crowdin-download.yml
  • actions/checkout v4
  • crowdin/github-action v1.15.2
.github/workflows/crowdin-upload.yml
  • actions/checkout v4
  • crowdin/github-action v1.15.2
.github/workflows/dependency-review.yml
  • actions/checkout v4
  • actions/dependency-review-action v3
.github/workflows/labeler.yml
  • actions/labeler v4.3.0
.github/workflows/lock.yml
  • dessant/lock-threads v5
.github/workflows/lychee.yml
  • actions/checkout v4
  • actions/cache v3
  • lycheeverse/lychee-action v1.8.0
  • peter-evans/create-issue-from-file v4
.github/workflows/pages-deployment.yaml
  • actions/checkout v4
  • pnpm/action-setup v2.4.0
  • actions/setup-node v4.0.0
  • cloudflare/pages-action v1.5.0
.github/workflows/pr-labels.yml
.github/workflows/rclone-action.yml
  • actions/checkout v4
.github/workflows/stale.yml
  • actions/stale v8.0.0
.github/workflows/sync-labels.yml
.github/workflows/trunk-check.yml
.github/workflows/trunk-upgrade.yml
  • actions/checkout v4
  • trunk-io/trunk-action c4b725db6be710c994ff4d175efefddb3cf86b59
npm
package.json
  • @docusaurus/core 3.0.1
  • @docusaurus/plugin-ideal-image 3.0.1
  • @docusaurus/plugin-pwa 3.0.1
  • @docusaurus/preset-classic 3.0.1
  • @docusaurus/theme-mermaid 3.0.1
  • @loadable/component 5.15.3
  • @mdx-js/react 3.0.0
  • asciinema-player 3.6.3
  • clsx 2.0.0
  • prism-react-renderer 2.3.0
  • react ^18.2.0
  • react-dom ^18.2.0
  • react-spinners 0.13.8
  • @crowdin/cli ^3.15.0
  • @docusaurus/eslint-plugin ^3.0.0
  • @docusaurus/module-type-aliases 3.0.1
  • @docusaurus/tsconfig 3.0.1
  • @docusaurus/types 3.0.1
  • @trunkio/launcher ^1.2.7
  • @types/node ^20.10.1
  • @typescript-eslint/eslint-plugin ^6.13.1
  • @typescript-eslint/parser ^6.13.1
  • eslint ^8.0.1
  • eslint-config-prettier ^9.0.0
  • eslint-import-resolver-typescript ^3.6.1
  • eslint-plugin-import ^2.29.0
  • eslint-plugin-react ^7.33.2
  • eslint-plugin-react-hooks ^4.6.0
  • stylelint ^15.11.0
  • stylelint-color-format ^1.1.0
  • stylelint-config-recess-order ^4.4.0
  • stylelint-config-standard ^34.0.0
  • stylelint-csstree-validator ^3.0.0
  • typescript 5.3.2
  • pnpm 8.11.0

  • Check this box to trigger a request for Renovate to run again on this repository

Algolia crawler (domain update)

Algolia crawler (domain update)

Ticket: https://support.algolia.com/hc/en-us/requests/505500

new Crawler({
appId: "FMPN8VE51Y",
  apiKey: "***",
  rateLimit: 8,
  startUrls: ["https://wiki.zshell.dev"],
  sitemaps: ["https://wiki.zshell.dev/sitemap.xml"],
  ignoreCanonicalTo: true,
  exclusionPatterns: [
    "https://wiki.zshell.dev/blog/**",
    "https://wiki.zshell.dev/legal/**",
    "https://wiki.zshell.dev/__docusaurus/**",
  ],
  schedule: "at 10:33 AM on Friday",
  discoveryPatterns: ["wiki.zshell.dev/**"],
  actions: [
    {
      indexName: "zshell",
      pathsToMatch: ["wiki.zshell.dev/**"],
      recordExtractor: ({ $, helpers }) => {
        // priority order: deepest active sub list header -> navbar active item -> 'Documentation'
        const lvl0 =
          $(
            ".menu__link.menu__link--sublist.menu__link--active, .navbar__item.navbar__link--active"
          )
            .last()
            .text() || "Documentation";

        return helpers.docsearch({
          recordProps: {
            lvl0: {
              selectors: "",
              defaultValue: lvl0,
            },
            lvl1: ["header h1", "article h1"],
            lvl2: "article h2",
            lvl3: "article h3",
            lvl4: "article h4",
            lvl5: "article h5, article td:first-child",
            lvl6: "article h6",
            content: "article p, article li, article td:last-child",
          },
          indexHeadings: true,
          aggregateContent: true,
          recordVersion: "v3",
        });
      },
    },
  ],
  initialIndexSettings: {
    "z-digitalclouds": {
      attributesForFaceting: [
        "type",
        "lang",
        "language",
        "version",
        "docusaurus_tag",
      ],
      attributesToRetrieve: [
        "hierarchy",
        "content",
        "anchor",
        "url",
        "url_without_anchor",
        "type",
      ],
      attributesToHighlight: ["hierarchy", "content"],
      attributesToSnippet: ["content:10"],
      camelCaseAttributes: ["hierarchy", "content"],
      searchableAttributes: [
        "unordered(hierarchy.lvl0)",
        "unordered(hierarchy.lvl1)",
        "unordered(hierarchy.lvl2)",
        "unordered(hierarchy.lvl3)",
        "unordered(hierarchy.lvl4)",
        "unordered(hierarchy.lvl5)",
        "unordered(hierarchy.lvl6)",
        "content",
      ],
      distinct: true,
      attributeForDistinct: "url",
      customRanking: [
        "desc(weight.pageRank)",
        "desc(weight.level)",
        "asc(weight.position)",
      ],
      ranking: [
        "words",
        "filters",
        "typo",
        "attribute",
        "proximity",
        "exact",
        "custom",
      ],
      highlightPreTag: '<span class="algolia-docsearch-suggestion--highlight">',
      highlightPostTag: "</span>",
      minWordSizefor1Typo: 3,
      minWordSizefor2Typos: 7,
      allowTyposOnNumericTokens: false,
      minProximity: 1,
      ignorePlurals: true,
      advancedSyntax: true,
      attributeCriteriaComputedByMinProximity: true,
      removeWordsIfNoResults: "allOptional",
      separatorsToIndex: "_",
    },
  },
});

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.