User Manual for the Automated Pipeline Tool

User Manual for the Automated Pipeline Tool#

Welcome to your starting point for building a custom digital textbook with the Automated Pipeline Tool! Whether you’re an instructor, student, or self-learner, this manual will guide you step-by-step—from setup to publishing your own interactive Jupyter Book. No advanced technical skills required—just follow along and you’ll be up and running in no time.

Tip: Use the navigation bar to jump to Quickstart, Pipeline Overview, Usage Guide, Troubleshooting, or FAQ.

What is the Automated Pipeline Tool?#

The Automated Pipeline Tool streamlines the process of turning raw lecture content into a polished, interactive digital textbook. It automates file parsing, content structuring, and publishing, so you can focus on teaching and learning rather than formatting.

  • Automated Formatting: Converts messy notes into clean, structured MyST Markdown.

  • Batch Processing: Handles multiple lectures at once for consistency and speed.

  • Jupyter Book Integration: Publishes your content as a beautiful, interactive book.

  • Version Control: Seamlessly integrates with Git and GitHub for collaboration and review.

How to Get Started#

Jupyter Book is an open-source tool for building publication-quality books and documents from markdown files and Jupyter Notebooks. It is ideal for creating interactive textbooks, technical documentation, and lecture notes.

  • Official Documentation: https://jupyterbook.org/

  • Key Features:

    • Write content in MyST Markdown or Jupyter Notebooks

    • Add interactive code, figures, and equations

    • Organize content with a table of contents

    • Publish as a static website or PDF

Tip

Start by exploring the Jupyter Book Getting Started Guide to understand the basics of structure, configuration, and publishing.

MyST Markdown extends standard Markdown with directives, roles, and features for scientific publishing and interactivity.

Note

MyST is the recommended format for Jupyter Book content.

Copilot Agent Mode helps automate the process of converting raw lecture content into well-structured MyST Markdown. It can:

  • Format messy notes into clean lecture files

  • Insert code blocks, admonitions, and review questions

  • Follow your custom formatting rules

How to Use:

  1. Open your workspace in VS Code.

  2. Activate Copilot Agent Mode (see the extension bar or command palette).

  3. Provide your raw lecture content and specify your formatting preferences.

  4. Let Copilot generate or edit markdown files for you.

Note

Copilot Agent Mode is especially useful for batch-processing multiple lectures or ensuring consistency across your textbook.

Tip

These resources provide deeper insights and practical examples to help you get the most out of the pipeline and its tools.

Next Steps#

  • Head to the Quickstart section for a step-by-step setup guide.

  • Explore the Pipeline Overview to understand the workflow in detail.

  • Check the Usage Guide for practical tips and advanced features.

  • Visit Troubleshooting and FAQ if you run into any issues.

Contents