Turn your ebook into a beautiful, easy-to-navigate website using the power of 11ty, a simpler static site generator. This project provides a solid starting point with a pre-configured template, streamlined chapter management, and customizable themes.
- Quick Deploy
- Features
- Demo
- Getting Started
- Deployment
- Updating the Template
- Customization
- Contributing
- Troubleshooting
- License
Quickly deploy your own copy of this project to Netlify with one click:
This 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.
- Effortless Setup: Get up and running quickly with a well-structured template and clear installation instructions.
- Chapter Organization: Manage your ebook's chapters easily in individual Markdown files.
- Navigation Made Easy: Automatic generation of a chapter-based navigation menu (hamburger menu on non-homepage pages).
- Customizable Themes: Choose from multiple built-in themes to style your ebook website.
- Fast and Lightweight: 11ty ensures a blazing-fast website experience for your readers.
- SEO-Friendly: Meta tags for better search engine optimization are included.
- Social Links: Make it easy for readers to find you on social media sites as well.
Check out the live demo of this ebook template: Demo 1, Demo 2
Check out PutOut documentation for more detailed information.
- Use This Template:
Click the "Use this template" button at the top of this repository to create your own copy.
- Clone Your Repository:
git clone https://github.com/<username>/<repository>.git
cd <repository>
- Install Dependencies:
npm install
- Configure Your Ebook:
- Open
src/_data/site.js
and customize the settings (title, author, description, social links, etc.) to match your ebook. - Replace the sample chapters in
src/chapters
with your ebook's chapters (in Markdown format).
- Start Development Server:
npm run start
This will start a local development server at http://localhost:8080/
. Open this URL in your web browser.
- Build for Production:
npm run build
This will generate your static website files in the dist/
directory, ready for deployment.
The easiest way to deploy your ebook website is with Netlify:
- Push your project to your GitHub repository.
- Create a new site on Netlify and connect it to your GitHub repository.
- Configure build settings (if needed): Set the build command to
npm run build
and the publish directory todist/
. - Deploy: Netlify will automatically build and deploy your site whenever you push changes to your repository.
Learn more about deployment
To get the latest updates from the original template:
- Add the original repository as a remote (you only need to do this once):
git remote add template https://github.com/deepakness/putout.git
- Fetch the latest changes:
git fetch template
- Merge the changes into your main branch:
git merge template/main --allow-unrelated-histories
- Resolve any conflicts and commit the changes:
git add .
git commit -m "Merged updates from template"
- Push the changes to your repository:
git push origin main
- Themes: Modify or add themes in
src/_data/themes.js
. - Layouts: Customize page layouts in
src/_includes/
. - Styles: Adjust styles by modifying
tailwind.config.js
andsrc/styles/tailwind.css
.
Learn more about customization
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
- Build Errors: Ensure all dependencies are installed (
npm install
) and you're using a compatible Node.js version. - Styling Issues: Check your
tailwind.config.js
and ensure you've rebuilt your CSS (npm run build:css
). - Content Not Updating: Make sure your Markdown files are in the correct location and format.
For more help, please open an issue.
This project is licensed under the MIT License. See the LICENSE file for details.