GithubHelp home page GithubHelp logo

dani3lheidemann / notion-pdf-export Goto Github PK

View Code? Open in Web Editor NEW

This project forked from ganeshh123/notion-pdf-export

0.0 0.0 0.0 88.86 MB

A tool to allow batch PDF export for free Notion users. You can export as HTML and then use this tool to convert those into PDFs.

License: MIT License

JavaScript 95.11% Batchfile 4.65% Shell 0.24%

notion-pdf-export's Introduction

Notion PDF Export

A tool to allow batch PDF export for free Notion users. You can export as HTML with subpages and then use this tool to convert those into PDFs.

Download

Get the latest download for Windows and Mac from the releases page:

https://github.com/ganeshh123/notion-pdf-export/releases

Download for Windows

Download for Mac

Usage

video guide Video Guide

  1. Download the tool and extract.

    downloaded_program

  2. In Notion, place all the pages you wish to export into one page and click Export, choose 'HTML' and ensure 'Include Subpages' is on.

    notion-export

  3. Extract the export to find a list of HTML files and folders for each page. Place the HTML files with folders containing images in the same folder as 'notion-pdf-export.exe' (Windows) or 'notion-pdf-export' (Mac).

    placing-markdown-files

  4. Double Click 'notion-pdf-export.exe' (Windows) or 'notion-pdf-export' (Mac) and wait for the process to be completed.

    running-program

    If nothing happens, you may need to go to macOS security settings and click 'Open Anyway':

    macOS_security

  5. All the individual pages can be found converted into PDF Documents inside the pdfs folder.

    created_pdfs


Building

Running the Project on Node

  1. Clone/Download the project and run the command in the project root directory:

    npm install
  2. Run this command to run the script:

    node index.js

Compiling an Executable

This is tricky. A lot of adjustments had to be made so that it can run without node.

Installing nexe

Executables are compiled with a very specific version of nexe that allows access to the filesystem, which has a tricky setup procedure.

To Install Automatically:

Run install_nexe_win.bat as admin on Windows, will take about 5 minutes to install fully.

Or

Run install_nexe_mac on Mac, will take about 5 minutes to install, and you will need to enter password. This sometimes doesn't seem to work properly, so might be worth doing manual install if there's problems.

To Install Manually:

  1. Firstly, install the general nexe globally with the command:

    npm install -g nexe

    In Windows with Command Prompt running as Admin. Or:

    sudo npm install -g nexe

    In Mac in the terminal

  2. In the project root folder build some executables with this version of nexe to download node binaries for Windows and Mac:

    nexe . --target win32-x86-10.13.0
    nexe . -t macos-10.13.0

    This will download the binaries we need for later, delete the executables built with this for now.

  3. Now we need to install a specific version of nexe that allows access to the filesystem:

    Run the command:

    npm install -g cspotcode/nexe#19a5046

    In Windows with Command Prompt running as Admin. Or:

    sudo npm install -g cspotcode/nexe#19a5046

Now we should have the correct version of nexe for building.

Confirm by running:

nexe -v

nexe-version

Check that the version is 4.0.0-beta.4

Compiling Executables

Compile Automatically

Run build_win32.bat on Windows to build a Windows Executable. This can be found in /dist/win32 and everything in that folder must be distributed together.

Run build_macos on Mac to build a Mac Executable. This can be found in /dist/macos and everything in that folder must be distributed together.

If you wish to compile for Mac on Windows or Vice Versa, you can do so using the manual method below. This is trickier and will require obtaining a phantomjs binary built for the desired platform and placing it in the correct place.

Compile Manually

To build a Windows Executable, run the command:

nexe . --target win32-x86-10.13.0 -o ./dist/win32/notion-pdf-export.exe

in the root directory of the project.

To build a Mac executable, run the command:

nexe . -t macos-10.13.0 -o ./dist/macos/npe

in the root directory of the project. Note that this is built under the name 'npe' which is done for a reason.

To distribute the Windows Executable, place it in a directory with the following:

  • The original 'utils' folder from the source code

To distribute the Mac Executable (npe), place it in a directorywith the following:

  • The original 'utils' folder from the source code

  • An executable unix shell script with the following contents, called 'notion-pdf-export':

    #/bin/bash
    cd "$0"/..
    ./npe

    This can be obtained from 'mac_script.sh' or found inside /dist/macos

Credits

wkhtmltopdf

This project uses wkhtmltopdf for the conversions. This brilliant tool was created by Jakob Truelsen and is now maintained by Ashish Kulkarni. Version 0.12.6 has been used, and can be downloaded here.

wkhtmltopdf is released under the LGPL-3.0 License which can be found at utils/wkhtmltopdf/LICENSE. The source code is available at the wkhtmltopdf repository.

Assets

Notion Icon by Alex Martinov on Iconscout

notion-pdf-export's People

Contributors

ganeshh123 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.