Skip to content

README.md

Latest commit

 

History

History
53 lines (34 loc) · 1.21 KB

README.md

File metadata and controls

53 lines (34 loc) · 1.21 KB

Fetch Definitions

Fetch Definitions is a command-line tool to retrieve word definitions from websters1913.com and save them in Obsidian Markdown format with callouts.

Features

  • Fetch definitions for multiple words concurrently
  • Automatically lemmatize words to increase the chances of finding definitions
  • Save definitions for use in Obsidian.

Installation

  1. Clone the repository:
git clone https://github.com/a-n-t-h-o-n-y/fetch-definitions.git
  1. Change into the project directory:
cd fetch-definitions
  1. Install the dependencies:
npm install

Usage

Run the tool with the following command:

npm start -- <input-file> <output-location>
  • <input-file>: The path to the input .txt file containing the list of words, one word per line.
  • <output-location>: The directory or filepath where the Markdown file will be saved.

If a directory is given for <output-location> the output filename will be generated from the input filename.

For example:

npm start -- input.txt ./out/book-i-am-reading.md

License

This project is licensed under the MIT License. See the LICENSE file for details.