{"id":15016499,"url":"https://github.com/deepakness/putout","last_synced_at":"2026-02-08T19:25:22.827Z","repository":{"id":248349395,"uuid":"828455144","full_name":"deepakness/putout","owner":"deepakness","description":"PutOut is an open-source, self-hosted solution that turns your ebook chapters into beautiful, responsive websites.","archived":false,"fork":false,"pushed_at":"2025-01-20T03:37:30.000Z","size":1110,"stargazers_count":16,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T09:52:48.814Z","etag":null,"topics":["11ty","ebook","jamstack","publishing","static-site-generator","tailwindcss"],"latest_commit_sha":null,"homepage":"https://putout.org","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/deepakness.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"zenodo":null}},"created_at":"2024-07-14T07:47:42.000Z","updated_at":"2025-03-29T13:42:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"3247605d-1ff3-449a-95bf-1fd3ea5394a6","html_url":"https://github.com/deepakness/putout","commit_stats":{"total_commits":9,"total_committers":2,"mean_commits":4.5,"dds":0.4444444444444444,"last_synced_commit":"326af59063658755ccb08ecb053a9d9cf9f7adc3"},"previous_names":["deepakness/putout"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/deepakness/putout","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepakness%2Fputout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepakness%2Fputout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepakness%2Fputout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepakness%2Fputout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deepakness","download_url":"https://codeload.github.com/deepakness/putout/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepakness%2Fputout/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265534572,"owners_count":23783858,"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":["11ty","ebook","jamstack","publishing","static-site-generator","tailwindcss"],"created_at":"2024-09-24T19:48:59.695Z","updated_at":"2026-02-08T19:25:22.821Z","avatar_url":"https://github.com/deepakness.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# PutOut - Ebook-to-Website with 11ty\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Version](https://img.shields.io/github/package-json/v/deepakness/putout)](https://github.com/deepakness/putout)\n[![Last Commit](https://img.shields.io/github/last-commit/deepakness/putout)](https://github.com/deepakness/putout/commits/main)\n\nTurn your ebook into a beautiful, easy-to-navigate website using [Eleventy (11ty) v3](https://www.11ty.dev/) and [Tailwind CSS v3](https://tailwindcss.com/). This project provides a solid starting point with a pre-configured template, streamlined chapter management, 8 accent color palettes, and reader-controlled dark mode.\n\n## Table of Contents\n\n- [Quick Deploy](#quick-deploy-)\n- [Features](#features-)\n- [Demo](#demo-)\n- [Getting Started](#getting-started-)\n- [Deployment](#deployment-)\n- [Updating the Template](#updating-the-template-)\n- [Customization](#customization-)\n- [Contributing](#contributing-)\n- [Troubleshooting](#troubleshooting-)\n- [License](#license-)\n\n## Documentation 📖\n\nFull documentation is available on the [PutOut Wiki](https://github.com/deepakness/putout/wiki) — covers configuration, chapters, theming, SEO, accessibility, PDF/EPUB generation, deployment, and more.\n\n## Quick Deploy ⚡️\n\nQuickly deploy your own copy of this project to Netlify with one click:\n\n[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/deepakness/putout)\n\nThis will create a new repository in your GitHub account with this project's files, connect it to Netlify, and deploy it. You can later make changes to the GitHub repository.\n\n## Features ✨\n\n- **Effortless Setup:** Get up and running quickly with a well-structured template and clear installation instructions.\n- **Chapter Organization:** Manage your ebook's chapters easily in individual Markdown files.\n- **Navigation:** Sidebar navigation with hamburger menu, keyboard shortcuts (arrow keys), swipe gestures on mobile, and a mobile bottom nav bar.\n- **8 Accent Colors:** Choose from emerald, indigo, rose, amber, blue, violet, teal, or orange to brand your site. Set one value in `site.js`.\n- **Dark Mode:** Reader-controlled light/dark/auto toggle with localStorage persistence and anti-FOUC script.\n- **Reading Experience:** Progress bar, reading time estimates, scroll-to-top button, and next-chapter prefetch at 50% scroll.\n- **Fast and Lightweight:** Eleventy v3 ensures a blazing-fast website experience for your readers.\n- **SEO-Friendly:** Meta tags, JSON-LD structured data (Book + Article schemas), XML sitemap, and robots.txt.\n- **Accessibility:** Skip-to-content link, focus-visible styles, keyboard navigation, noscript fallback, and print stylesheet.\n- **Social Links:** Make it easy for readers to find you on social media.\n- **PDF and EPUB Generation:** Automatically generate PDF and EPUB files for your ebook.\n- **Custom 404 Page:** Styled error page with chapter directory for easy recovery.\n\n## Demo 🚀\n\nCheck out the live demo of this ebook template: [Demo](https://ebook.untalkedseo.com/)\n\n## Getting Started 🛠️\n\n**Prerequisites:** Node.js 18 or later.\n\n\n1. **Use This Template:**\n   \nClick the \"Use this template\" button at the top of this repository to create your own copy.\n\n2. **Clone Your Repository:**\n\n```bash\ngit clone https://github.com/\u003cusername\u003e/\u003crepository\u003e.git\n```\n\n```bash\ncd \u003crepository\u003e\n```\n\n3. **Install Dependencies:**\n\n```bash\nnpm install\n```\n\n4. **Configure Your Ebook:**\n\n- Open `src/_data/site.js` and customize the settings (title, author, description, social links, etc.) to match your ebook.\n- Replace the sample chapters in `src/chapters` with your ebook's chapters (in Markdown format).\n\n5. **Start Development Server:**\n\n```bash\nnpm run start\n```\nThis will start a local development server at `http://localhost:8080/`. Open this URL in your web browser.\n\n6. **Build for Production:**\n\n```bash\nnpm run build\n```\nThis will generate your static website files in the `dist/` directory, ready for deployment.\n\n## Deployment 🚀\n\nThe easiest way to deploy your ebook website is with [Netlify](https://www.netlify.com/):\n\n1. Push your project to your GitHub repository.\n2. Create a new site on Netlify and connect it to your GitHub repository.\n3. Configure build settings (if needed): Set the build command to `npm run build` and the publish directory to `dist/`.\n4. Deploy: Netlify will automatically build and deploy your site whenever you push changes to your repository.\n\n\n## Updating the Template 🔄\n\nTo get the latest updates from the original template:\n\n1. Add the original repository as a remote (you only need to do this once):\n\n```bash\ngit remote add template https://github.com/deepakness/putout.git\n```\n\n2. Fetch the latest changes:\n\n```bash\ngit fetch template\n```\n\n3. Merge the changes into your main branch:\n\n```bash\ngit merge template/main --allow-unrelated-histories\n```\n\n4. Resolve any conflicts and commit the changes:\n\n```bash\ngit add .\n```\n\n```bash\ngit commit -m \"Merged updates from template\"\n```\n\n5. Push the changes to your repository:\n\n```bash\ngit push origin main\n```\n\n## Customization 🎨\n\nAll key settings live in **`src/_data/site.js`**:\n\n- **Accent Color:** Set `theme` to one of: `emerald`, `indigo`, `rose`, `amber`, `blue`, `violet`, `teal`, `orange`. This changes buttons, links, highlights, and all branded elements across the site. Colors are defined in `src/_data/accentColors.js`.\n- **Dark Mode:** Readers control light/dark/auto mode via a toggle in the footer. No configuration needed — it works out of the box with localStorage persistence.\n- **Fonts:** Set `fonts.heading` and `fonts.body` to any Google Fonts family name. No need to touch `tailwind.config.js`.\n- **New Chapters:** Copy `src/chapters/_chapter-template.md`, rename with a number prefix (e.g., `04-my-chapter.md`), and fill in the frontmatter (`title`, `description`, `permalink`). The `permalink` field controls the URL (e.g., `permalink: \"/my-chapter/\"`).\n- **Layouts:** Customize page layouts in `src/_includes/`.\n\n\n## Contributing 🤝\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## Troubleshooting 🔧\n\n- **Build Errors:** Ensure all dependencies are installed (`npm install`) and you're using a compatible Node.js version.\n- **Styling Issues:** Check your `tailwind.config.js` and ensure you've rebuilt your CSS (`npm run build:tailwind`).\n- **Content Not Updating:** Make sure your Markdown files are in the correct location and format.\n\nFor more help, please [open an issue](https://github.com/deepakness/putout/issues).\n\n## License 📄\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepakness%2Fputout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeepakness%2Fputout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepakness%2Fputout/lists"}