Skip to content

kinseyda/wikid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wikid

Description

Wikid is a terminal-based Wikipedia search engine / reader. It indexes a Wikipedia dump and allows you to search for articles. After searching, you can view the article entirely in your terminal - or export it to the clipboard as Markdown (or MediaWiki markup) to be viewed in any other viewer you like.

Demo

demo.gif

Requirements

Details

Wikid works by first scanning the dump file via some strategy, then sending the results to MeiliSearch to be indexed. These operations are separated purposefully: indexing can be much slower than scanning, but it can be resumed when a user closes the program.

TODO

  • Refactor main so that the update function is less monolithic
  • Scan stats should allow for concurrent scans - give each one a UID and store a map?
  • Cancel ability for the meiliseach tasks? GetPageByTitle is quite slow
  • Link resolution for unambiguous section links
    • Might require storing page's headers in index
  • Auto scroll for section links
  • Settings
    • Indexing options
    • Search options
  • Documentation
  • Theming support (?)
  • Tests
  • Improve mediawiki to markdown conversion speed (alternative to pandoc needed)
  • Touch support?

About

A terminal-based reader for Wikipedia dumps

Resources

License

Stars

Watchers

Forks

Languages