Skip to content

PubDoc is a command-line tool that converts EPUB books into Docusaurus documentation sites. It extracts content from EPUB files, converts HTML to Markdown, and organizes the content in a Docusaurus project structure, making it easy to publish books as documentation websites.

License

Notifications You must be signed in to change notification settings

kinensake/pubdoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PubDoc

PubDoc is a command-line tool that converts EPUB books into Docusaurus documentation sites. It extracts content from EPUB files, converts HTML to Markdown, and organizes the content in a Docusaurus project structure, making it easy to publish books as documentation websites.

Installation

Prerequisites

  • Go 1.21 or higher

Install from source

# Clone the repository
git clone https://github.com/kinensake/pubdoc.git
cd pubdoc

# Build the binary
go build -o pubdoc

# Move to a directory in your PATH (optional)
sudo mv pubdoc /usr/local/bin/

Install using Go

go install github.com/kinensake/pubdoc@latest

Usage

Create a new Docusaurus project

pubdoc new my-book-site
cd my-book-site

Add an EPUB book to your project

pubdoc add /path/to/your/book.epub

Start the Docusaurus development server

npm start

Build for production

npm run build

Supporters

This project is enhanced with AI assistance for:

  • Comprehensive code documentation with GoDoc style comments
  • README generation and documentation
  • Docusaurus template enhancement

License

MIT License

About

PubDoc is a command-line tool that converts EPUB books into Docusaurus documentation sites. It extracts content from EPUB files, converts HTML to Markdown, and organizes the content in a Docusaurus project structure, making it easy to publish books as documentation websites.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published