[!IMPORTANT]
Microfish is in an extremely early, extremely rough state (v0.x.x). Keep this in mind until v1.x.x is released!
![Microfish](https://github.com/weebney/microfish/raw/c75eb7742d42/docs/github/head.svg)
Microfish PDF Reader
Microfish rips the heart out of Firefox's PDF reader and places it into a purpose-built cybernetic exoskeleton.
It's a sleek-and-slim standalone version of PDF.js, Firefox's PDF reader. It packages PDF.js into a 12 MB standalone program, meaning you can get the sexy, ultra-luxe PDF experience that Firefox provides but almost 10x faster. It's also got some extra goodies on top!
- Live Reloading
- Remote Documents
- Editing & Annotating
- Extremely Tiny & Perfomant
- Quick & Easy Installation
- Free and Open Source
All this and more ensures Microfish will be the last PDF reader you'll ever want to use—it takes the state-of-the-art in PDF display technology and gives it the power to be your daily document driver.
Using Microfish
Quick Links:
Microfish is extremely easy to use. Open it up, open a document by pressing the
, et voilà—you're ready to start reading!
Microfish for the Technically Savvy
If you want to open a document in your home directory's Documents folder, you can run:
mf ~/Documents/document.pdf
Or, if you want to view a document from the internet:
mf https://example.com/path/to/document.pdf
Building Microfish
See installation for build instructions!
Issues and Contributing
This project follows the following philosophy:
- If this project is not helping you, then there is a bug
- If you are having a bad time using this project, then there is a bug
- If the documentation is confusing, then the documentation is buggy
- If there is a bug in this project, then we can work together to fix it.
There is a list of known issues that are currently being worked on—if anything else comes up, though, please open an issue in the issue tracker.
Contributing
Microfish has only a few contribution rules to keep the project's codebase growing at a sustainable rate:
- Please squash your commits before submitting a pull request.
- Large pull requests should be split into multiple smaller pull requests where possible.
- Pull requests that include changes to the
frontend/src/pdfjs
folder will not be considered unless they provide a Microfish specific patch. If you want to propose changes to PDF.js, submit them upstream.
Shoutouts
- I can't possibly give a gracious enough thanks to Jonas Jenwald, Tim van der Meij, Calixte Denizet, Yury Delendik, Brendan Dahl, and all other contributors to PDF.js for their incredible work on the project. What a behemoth effort—enjoyed by millions daily—that is almost entirely taken for granted.
- Siddharth Dushantha, the creator of ff-pdf, which served both as my PDF reader before writing Microfish and as the inspiration for it. This guy is a machine, by the way; he's got so many great projects.
- Lea Anthony and other contributors to Wails. Wails is such a complex software sandwich, but thanks to their effort it's quite satisfying to work with.
- You, the reader! Thank you for using, supporting, and contributing to Microfish; without you, this project would not be possible.
![](https://starchart.cc/weebney/microfish.svg)