https://github.com/kenshinji/yddict

一个命令行查单词的工具💻 📚
https://github.com/kenshinji/yddict

dictionary hacktoberfest hacktoberfest2022 hacktoberfest2024 nodejs npm-package

Last synced: about 1 month ago
JSON representation

一个命令行查单词的工具💻 📚

• Host: GitHub
• URL: https://github.com/kenshinji/yddict
• Owner: kenshinji
• License: mit
• Created: 2017-08-24T12:27:51.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T22:48:25.000Z (about 1 month ago)
• Last Synced: 2024-10-30T23:24:23.315Z (about 1 month ago)
• Topics: dictionary, hacktoberfest, hacktoberfest2022, hacktoberfest2024, nodejs, npm-package
• Language: JavaScript
• Homepage:
• Size: 504 KB
• Stars: 376
• Watchers: 8
• Forks: 65
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-github-star - yddict

README

        
# 有道词典命令行查询工具 [English](./README_en.md)

>不喜欢安装有道词典的应用程序，因为太耗资源还一堆广告，但是用浏览器打开`dict.youdao.com`也挺麻烦的，不是吗？快来试试我的有道词典命令行工具吧！

[![GitHub stars](https://img.shields.io/github/stars/kenshinji/yddict.svg?style=plastic)](https://github.com/kenshinji/yddict/stargazers)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/kenshinji/yddict/blob/master/LICENSE.txt)

[![npm version](https://badge.fury.io/js/yddict.svg)](https://badge.fury.io/js/yddict)

[![Code Climate](https://codeclimate.com/github/kenshinji/yddict/badges/gpa.svg)](https://codeclimate.com/github/kenshinji/yddict)

[![Build Status](https://travis-ci.org/kenshinji/yddict.svg?branch=master)](https://travis-ci.org/kenshinji/yddict)

[![Coverage Status](https://coveralls.io/repos/github/kenshinji/yddict/badge.svg?branch=master)](https://coveralls.io/github/kenshinji/yddict?branch=master)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkenshinji%2Fyddict.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkenshinji%2Fyddict?ref=badge_shield)

[![gif with examples][examples-link]][examples-link]

## 安装

    npm install yddict -g

## 使用说明

    yd <要查询的单词>

 - ### 自定义设置

  目前自定义设置选项如下，可以通过用户主目录下`.config/configstore/yddict.json`文件来配置, 如果没有该文件，第一次运行之后会自动生成。

    {

      "proxy":"http://<主机地址>:<端口>" //代理设置

      "color":"<自定义显示颜色>" //自定义字体颜色显示，默认白色

    }

## 功能特点

- 支持英文查中文

- 支持中文查英文

- 支持发音标注

- 支持网络释义

- 支持自定义代理和颜色设置

## 命令行选项

    yd -h, --help     显示帮助信息

    yd -v, --version  显示版本号

    yd          查询单词或短语

## 系统要求

- Node.js >= 12.0.0

- npm >= 6.0.0

## 常见问题

如果安装或使用过程中遇到问题，请确保：

1. Node.js 版本符合要求

2. 使用 `npm install -g yddict` 进行全局安装

3. 如果在公司网络环境下使用，请正确配置代理设置

## 开源协议

MIT License

## 如何贡献代码

1. 先[fork](https://www.zhihu.com/question/20431718)这个代码库。

2. `npm install` 安装所需要的依赖。

3. 代码改动之后请运行`npm test`确保你的改动没有影响到其他的部分。

4. 提[PR](https://www.zhihu.com/question/21682976).

## 参与讨论

 1.  [Telegram 群](https://t.me/yddict)

[examples-link]:   https://raw.githubusercontent.com/kenshinji/yddict/master/example.gif

## 请作者喝一杯咖啡