📚 Keystone Template Core Slim

Welcome to the Keystone Template Core Slim repository! This project offers a developer-friendly book publishing template built on Keystone. The slim variant ensures a minimal project footprint while utilizing a public Docker image. This guide will help you understand the features, setup, and usage of this template.

🚀 Features

• Minimal Footprint: Designed for efficiency, this template uses a slim version of Keystone to reduce overhead.
• Docker Support: Run your book publishing workflow seamlessly with Docker.
• Markdown Support: Write your content in Markdown and convert it easily.
• PDF and EPUB Outputs: Generate professional-quality PDFs and EPUB files for your books.
• Integration with LaTeX: Use LaTeX for high-quality typesetting.
• Makefile Automation: Automate your build process with a simple Makefile.
• Customizable: Easily adapt the template to suit your publishing needs.

📦 Getting Started

To get started with the Keystone Template Core Slim, follow these steps:

Prerequisites

Before you begin, ensure you have the following installed:

• Docker
• Make

Installation

1. Clone the Repository:

   git clone https://github.com/metajul0327/keystone-template-core-slim.git
   cd keystone-template-core-slim

2. Download and Run Docker Image:

   You can download the latest release from the Releases section.

   Once downloaded, run the Docker container:

   docker run -it --rm -v $(pwd):/app -w /app your-docker-image-name

3. Build Your Project:

   Use the provided Makefile to build your project:

   make

4. Start Writing:

   Begin writing your book in the content/ directory. Use Markdown for your text files.

Example Structure

Here’s an example of how your project structure should look:

keystone-template-core-slim/
├── content/
│   ├── chapter1.md
│   └── chapter2.md
├── Makefile
├── Dockerfile
└── README.md

📖 Writing Your Book

The core of this template is writing your book in Markdown. Here are some tips:

• Use headers to organize chapters.
• Add images with relative paths.
• Use lists for easy readability.

Markdown Example

# My Book Title

## Chapter 1: Introduction

Welcome to my book! This is the first chapter.

![Cover Image](images/cover.jpg)

- Point 1
- Point 2

🛠️ Building Your Book

Once you’ve written your content, you can build your book into PDF or EPUB formats. Use the following commands:

Build PDF

To generate a PDF, run:

make pdf

Build EPUB

To generate an EPUB, run:

make epub

🌐 Topics Covered

This template covers a variety of topics essential for book publishing:

• Book Template: A structure to help organize your writing.
• Docker: Containerization for easy deployment.
• EPUB: A popular format for eBooks.
• Knight Owl: A tool for enhanced writing experiences.
• LaTeX: High-quality typesetting.
• Makefile: Automate your builds and tasks.
• Markdown: A simple way to format text.
• Pandoc: A powerful document converter.
• PDF: Standard format for printed books.
• Publishing: Tools and techniques for book publishing.
• Writing Tools: Enhance your writing process.

🎨 Customization

Feel free to customize the template to fit your needs. You can change styles, add new features, or integrate other tools. The template is designed to be flexible and adaptable.

📝 Contributing

We welcome contributions! If you have ideas or improvements, please submit a pull request. Here’s how you can contribute:

1. Fork the repository.
2. Create a new branch.
3. Make your changes.
4. Submit a pull request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🔗 Links

For more information, visit the Releases section to download the latest version.

📞 Contact

If you have any questions or feedback, feel free to reach out. You can open an issue in the repository or contact me directly.

---

Thank you for using the Keystone Template Core Slim! Happy writing!