Skip to content

Latest commit

 

History

History
116 lines (90 loc) · 5.64 KB

README.md

File metadata and controls

116 lines (90 loc) · 5.64 KB

Contributors Forks Stargazers Issues MIT License LinkedIn

Logo

PDF Notes

A markdown oriented note taking website for .pdf files

Explore the docs · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Usage
  3. Contributing
  4. License
  5. Contact

About The Project

PDF Notes is a light weight web app designed for easy, on-the-fly note taking on .pdf file. The app currently only supports markdown format as a way to save the notes. More info ara available in the [[#usage]] section.

(back to top)

Usage

To use the application, please visit the GitHub page website.

After choosing a .pdf file and clicking on "upload" the website will display the document's pages, each paired with a blank text area where to take notes related to the respective page.

The website offers a window option to select which pages —together with their relative sidenote— will be saved. Additionally, the user can manually select which pages to ignore during the saving process by using the buttons located next to them.

Finally, the user has the option to input a filename for the final markdown file. After clicking on the "save" button, the website will start 2 downloads:

  • a markdown file with the specified filename, containing the embedding syntax for all the selected document pages together with the optional notes (placed under the respective page)
  • a zipped folder containing .png files for all the document pages embedded in the markdown file

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Tobia Marco Cimino

(back to top)