https://github.com/faizan-ali/quickwiki

Script to read a Wiki page extract in the shell w/ menu navigation to sections
https://github.com/faizan-ali/quickwiki

chalk htmlparser2 javascript mediawiki-api nodejs shell-util termina-kit typescript wiki-extract wikipedia-api

Last synced: about 1 month ago
JSON representation

Script to read a Wiki page extract in the shell w/ menu navigation to sections

• Host: GitHub
• URL: https://github.com/faizan-ali/quickwiki
• Owner: faizan-ali
• Created: 2018-06-18T06:37:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-07-23T06:25:30.000Z (over 7 years ago)
• Last Synced: 2025-04-05T23:17:34.773Z (11 months ago)
• Topics: chalk, htmlparser2, javascript, mediawiki-api, nodejs, shell-util, termina-kit, typescript, wiki-extract, wikipedia-api
• Language: TypeScript
• Homepage:
• Size: 4.17 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# QuickWiki

Quick script to read a Wiki extract in the shell. This allows you to query Wikipedia from right within the shell!

Displays a summary of the query along with a selectable menu of sections. 

Highlights keywords in `/src/key-words.ts` in red for quick skims

## Usage

`npm install -g qwikipedia` 

`wiki democracy`

![alt text](/quickwiki.png "Screenshot")

## Keys:

* Exit: `Esc` or `Ctrl+C`

* New query: `q` followed by query followed by `Enter`

* Choose new page with '/' key

## Built With

* [Typescript](http://www.dropwizard.io/1.0.2/docs/) - The language used

* [Chalk](https://maven.apache.org/) - For fancy console output

* [MediaWiki API](https://rometools.github.io/rome/) - To query Wikipedia

* [HTMLParser2](https://rometools.github.io/rome/) -  To parse HTML from MediaWiki API

## License

This project is licensed under the MIT License