Skip to content

thopay/recipeScraper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


recipeScraper

A super simple recipe scraper to convert a PDF recipe book to JSON or Markdown
Explore the docs »
Report Bug · Request Feature

Table of Contents

About The Project

I was inspired to create this because I've been building my Obisdian Vault and wanted to add recipes to my recipe section. I found that I really enjoyed the recipes from @theremingtonjames and figured I'd try to convert his recipe book to match my recipe template format for Obsidian.

My Recipe Template RJF's Recipe Example

Demo

2023-02-27.23-02-03.-.Trim.mp4

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • RJF Cookbook (or ability to adjust code to scrape your cookbook of choice)

Installation

  1. Clone the repo
git clone https://github.com/thopay/recipeScraper.git
  1. Install NPM packages
npm install
node index

Usage

Place the cookbook in the project directory (rename cookbook to "cookbook.pdf" or adjust code to account for custom file name). Create a folder titled recipes in the project directory. Run the file to generate the markdown files. (Adjust the functions to account for preferred template or formatting to your liking)

Roadmap

  • Nothing specific at the moment, but I might work on adding other cookbooks

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License.

Contact

Thomas - @th___mas - me@thopay.dev

Project Link: https://github.com/thopay/recipeScraper

About

Super simple recipe scraper from a PDF formatted cookbook

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors