Skip to content

A Restful, powerful and Light Weight JavaScript Library that connects Wikipedia API!

License

Notifications You must be signed in to change notification settings

Wikifox/wikifox.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wikifox JS v2

WikifoxJS is a light-weight, small, powerful and restful Javascript library which connects to Wikipedia API. This library can be used to get content from wikipedia. Real life use case 👉 Wikifox

npm version npm downloads Standard - JavaScript Style Guide

📃 Table Of Content

💫 What's new ? npm version

  1. Moved from CommonJS to ES
  2. Improved Stability
  3. New features
    • Full page HTML
    • Improved Results
    • Validation

✨ Features

Wikifox has a bunch of features to access data from wikipedia. Wikifox is capable of doing the following things with ease:

  • 🎃 Option to select specific wikipedia or language. Refer Wikipedia Editions or Language
  • ✍️ Brief Summary about specific article. Not too small, but not too big!
  • 📰 Full Summary about the article includes all information in the form of text from the article
  • 🧑‍💻 Full Page data as HTML format. It gives you all the data in HTML format
  • 🎲 Get random Random article
  • 🖼️ Get the main picture/Thumbnail from a specific article
  • 📷 All the images on an article. It gives all the images used in a specific article
  • 📂 Full Article PDF. Provides link to download full articl ad PDF. Supports direct downloading.
  • 🪴 Today in history give you information about the specific date
  • 🔍 Search article by it's title. Also gives suggession and small snippet
  • 🔬 Validate Article. Can be used to check if there is an article with the id or title
  • 📃 List of available wikipedia

⬆️ Upcoming features

  • Information about edits and revision
  • User information
  • 🌟 WIKIFOX.PY moduule for python ! 🌟
  • And much more!

⚒️ Installation

You can easily install wikifox into your project with npm by pasting the following command in your terminal!

npm install wikifox

⚙️ Usage

In version 2, you can import modules separately according to your need. The available modules are as below. Just click it to see the detailed documentation on how to use it!

module Description Methods type
Article To get information about a specific article getSummary, getContent, getHTML class
Media To get media and files from a specific article getThumbnail, getImages, getPDF class
Search Search articles by title getHTMLsearchArticleByTitle object
Validate To check if article with the given title exist checkIfExists object
Random Get random articles, or Wikipedias Articles, Language object
Today Get today in History/ On this day from specific date GetOnThisDay object
Languages List of available Wikipedias and their name, language and code. Codes, Search object

🛡️ License

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

💪 Support

Please consider ⭐ Starring this repo or Buy me a coffee if you can ☕. If you have any questions or feedback, feel free to contact me at harrytom2606@gmail.com, Twitter @me_harrify or Discord harrify#0111

Made with ❤ · 🧑 by Harry · 💪 Powered by 🌍 Wikipedia