{"id":18754873,"url":"https://github.com/daniel-j/fimfic2epub","last_synced_at":"2025-04-13T01:12:39.666Z","repository":{"id":39988514,"uuid":"61499006","full_name":"daniel-j/fimfic2epub","owner":"daniel-j","description":"📚 Chrome/Firefox extension \u0026 npm package for improved EPUB export on fimfiction.net","archived":false,"fork":false,"pushed_at":"2024-04-11T15:10:44.000Z","size":1438,"stargazers_count":21,"open_issues_count":17,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-13T01:12:26.515Z","etag":null,"topics":["chrome-extension","ebook","epub","fanfiction","fimfiction","mithril"],"latest_commit_sha":null,"homepage":"http://fimfiction.djazz.se","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/daniel-j.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-06-19T20:29:51.000Z","updated_at":"2025-03-11T03:15:31.000Z","dependencies_parsed_at":"2023-02-18T10:32:18.759Z","dependency_job_id":"d8ac03dc-53e8-4eab-8082-12fc86ea7434","html_url":"https://github.com/daniel-j/fimfic2epub","commit_stats":{"total_commits":291,"total_committers":4,"mean_commits":72.75,"dds":"0.19931271477663226","last_synced_commit":"d38d7ab8be9b75a38cdd5820902b054a5230adc2"},"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daniel-j%2Ffimfic2epub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daniel-j%2Ffimfic2epub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daniel-j%2Ffimfic2epub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daniel-j%2Ffimfic2epub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daniel-j","download_url":"https://codeload.github.com/daniel-j/fimfic2epub/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650754,"owners_count":21139681,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chrome-extension","ebook","epub","fanfiction","fimfiction","mithril"],"created_at":"2024-11-07T17:30:31.262Z","updated_at":"2025-04-13T01:12:39.637Z","avatar_url":"https://github.com/daniel-j.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM](https://nodei.co/npm/fimfic2epub.png?compact=true)](https://www.npmjs.com/package/fimfic2epub)\n\n![fimfic2epub logo](https://github.com/daniel-j/fimfic2epub/raw/master/assets/fimfic2epub-logo.png)\n\nfimfic2epub\n===========\nThis is a tool to generate better EPUB ebooks from [Fimfiction](https://fimfiction.net/) stories. It's also a Chrome/Firefox extension, replacing the default EPUB download option with this tool. If you're on an Arch Linux-based system you can install it from the [Arch User Repository](https://aur.archlinux.org/packages/fimfic2epub/).\n\n[Screenshot](http://i.imgbox.com/MalEBiuC.png) of the web extension\n\n\nFeatures\n--------\n* The generated ebook is in modern EPUB3 format with fallbacks for older EPUB2 reading systems\n* Improved styling and formatting of content compared to Fimfiction's export options\n* Cover image can be changed from an image file or url\n* Downloads and embeds artwork from the story inside the EPUB file, including YouTube thumbnails, for optimal offline reading and archiving (optional)\n* Rating, tags, status, story description and more info are available on the title page\n* The table of contents page includes chapter modification dates and word counts\n* Option to put all author notes in an index at the end of the ebook\n* Option to not add a title heading for chapters (in case the story has its own)\n* Tweak paragraph style from double-spaced to indented (similar to book typesetting, may not look good on every story)\n* Emoji, icon and webp support (webp images gets converted to png)\n* Calculate the [Flesch reading ease](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests#Flesch_reading_ease) value of the story\n* Customize metadata of the generated ebook, such as title, author, subjects and description\n* Command line tool with same features as the web extension\n\n\nDemo\n----\nYou can have a look at what a generated EPUB looks like [here](http://books.djazz.se/?epub=epub_content%2Fsummer_island). It was generated from the story [Summer Island](https://fimfiction.net/story/289663/summer-island).\n\n\nUsage (web extension)\n-----------------\nYou can download the Chome extension from [Chrome Web Store](https://chrome.google.com/webstore/detail/fimfic2epub/fiijkoniocipeemlflajmmaecfhfcand) and [Firefox Add-ons](https://addons.mozilla.org/firefox/addon/fimfic2epub/)\n\n\nInstallation \u0026 usage (command line)\n-------------------\nYou can install the tool by running `npm install -g fimfic2epub`. On Arch Linux-based systems you can install it from the AUR like this: `yay -S fimfic2epub` (replace `yay` with your favorite AUR-helper)\n\nYou can then run the tool it like this:\n\n`$ fimfic2epub \u003cstory id/url\u003e [\u003coptional filename\u003e]`\n\nBy default the EPUB will be saved in the current working directory with the filename `Author - Title.epub`. Run `fimfic2epub -h` to see a list of all flags.\n\n```\n  Usage: fimfic2epub [options] \u003cstory\u003e [filename]\n\n  Tool to generate improved EPUB ebooks from Fimfiction stories\n\n  Options:\n\n    -V, --version                output the version number\n    -d, --dir \u003cpath\u003e             Directory to store ebook in. Is prepended to filename\n    -t, --title \u003cvalue\u003e          Set the title of the story\n    -a, --author \u003cvalue\u003e         Set the author of the story\n    -T, --typogrify              Enable typographic fixes (smart quotes, dashes, ellipsis, ordinal)\n    -c, --no-comments-link       Don't add link to online comments\n    -H, --no-headings            Don't add headings to chapters (includes chapter title, duration and word count)\n    -W, --no-chapter-word-count  Don't add word count to chapter headings\n    -D, --no-chapter-duration    Don't add time to read to chapter headings\n    -b, --no-bars                Don't add chapter bars to show reading progress\n    -r, --no-reading-ease        Don't calculate Flesch reading ease\n    -e, --no-external            Don't embed external resources, such as images (breaks EPUB spec)\n    -n, --no-notes               Don't include author notes\n    -i, --notes-index            Create an index with all author notes at the end of the ebook\n    -p, --paragraphs \u003cstyle\u003e     Select a paragraph style \u003cspaced|indented|indentedall|both\u003e (default: spaced)\n    -k, --kepubify               Add extra \u003cspan\u003e elements for Kobo EPUB (KEPUB) format\n    -j, --join-subjects          Join dc:subjects to a single value\n    -w, --wpm \u003cnumber\u003e           Words per minute. Set to 0 to disable reading time estimations (default: 200)\n    -C, --cover \u003curl\u003e            Set cover image url\n    -h, --help                   output usage information\n```\n\nExamples\n--------\n```\nDownload with automatic filename:\n$ fimfic2epub 289663\n$ fimfic2epub https://www.fimfiction.net/story/289663/summer-island\n\nDownload and save to a specified dir/filename:\n$ fimfic2epub 289663 path/to/file.epub\n$ fimfic2epub --dir path/to/my/dir 289663 ebook_%id%.epub # %id% gets replaced by the story id\n```\n\n\nBuilding\n--------\nMake sure [Node.js](https://nodejs.org) is installed. After you've cloned this repository, run `npm install` and `npm run build` to build it. This project uses [gulp](http://gulpjs.com/).\n\n\nDevelopment\n-----------\nWhen developing the code, you can run `npm run dev watch`. This will rebuild the code quickly and lint it when you save. To just lint, run `npm run dev lint` and to clean, run `npm run dev clean`. To build for production, just run `npm run build`.\n\nTo test the Chrome extension, click Load Unpacked and pick the `extension/` directory. To test the Firefox extension, go to Add-ons and Debug Add-ons. Then Load Temporary Add-on and pick the `extension.xpi` file. To reload them after a rebuild, click the Reload button in Chrome and/or Firefox.\n\nLicense\n-------\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaniel-j%2Ffimfic2epub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaniel-j%2Ffimfic2epub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaniel-j%2Ffimfic2epub/lists"}