jamie-taylor-rjj/podcast-faqs

A repo containing a number of FAQ documents for the different podcasts that RJJ Creates

Podcast-FAQs

A repo containing a number of FAQ documents for the different podcasts that RJJ Creates

The markdown file found within this directory is used to quickly generate a Guest FAQ for interviews. This document is then sent to all guests who have arranged to be on the show.

Where to Start

If reading on GitHub, please start with the about.md file. Or if you would rather, please see the releases page to grab the latest automatic build of a single PDF.

Auto-Render

This repository is set up with GitHub Actions, and will automatically render the contents of the PDF when a push is made to the Master branch. The latest version of the rendered document can be found in the Actions tab.

Auto Build Status

Licence Used

See the contents of the LICENSE file for details

Code of Conduct

Podcast-FAQs has a Code of Conduct which all contributors, maintainers and forkers must adhere to. When contributing, maintaining, forking or in any other way changing the code presented in this repository, all users must agree to this Code of Conduct.

See Code of Conduct.md for details.

Pull Requests

Pull requests are welcome, but please take a moment to read the Code of Conduct before submitting them or commenting on any work in this repo.

Manually Rendering to PDF

One of the quickest and easiest ways to render this markdown to a PDF (for example) is to use PanDoc, which is available for free.

There are three documents in this repository, rendering them all requires the use of three commands:

# Render the Modern .NET Show FAQs
pandoc ./show-specifics/moderndotnet.md guest-faq.md about.md --pdf-engine=xelatex -o mdns-guest-faq.pdf --toc

# Render the Waffling Taylors FAQs
pandoc ./show-specifics/wafflingtaylors.md guest-faq.md about.md  --pdf-engine=xelatex-o wt-guest-faq.pdf --toc

# Render the generic podcasting FAQs
pandoc guest-faq.md about.md --pdf-engine=xelatex -o guest-faq.pdf --toc

These will render the documents. However the resulting PDF has very wide margins, as is the default in TeX based systems (which is what pandoc uses in the conversion). To produce a version of the document with smaller margins, use the following command:

# Render the Modern .NET Show FAQs
pandoc ./show-specifics/moderndotnet.md guest-faq.md about.md --pdf-engine=xelatex -V geometry:"top=2cm, bottom=1.5cm, left=2cm, right=2cm" -o mdns-guest-faq.pdf --toc

# Render the Waffling Taylors FAQs
pandoc ./show-specifics/wafflingtaylors.md guest-faq.md about.md --pdf-engine=xelatex -V geometry:"top=2cm, bottom=1.5cm, left=2cm, right=2cm" -o wt-guest-faq.pdf --toc

# Render the generic podcasting FAQs
pandoc guest-faq.md about.md --pdf-engine=xelatex -V geometry:"top=2cm, bottom=1.5cm, left=2cm, right=2cm" -o guest-faq.pdf --toc

Page Breaks

As the input files in this repo are markdown and they will be processed by pandoc's LaTeX engine, we can make use of \pagebreak commands. These are LaTeX native requests to the LaTeX engine to place the content which follows the request on the next page. This is different to \newpage, which acts more like a demand than a request - the result of \pagebreak isn't guaranteed to happen if there is already a natural page break following it.