The Markua Manual
The Markua Manual
How to Write in Markua on Leanpub
About the Book
Imagine you owned a magical typewriter.
When you used this magical typewriter, you wrote with fewer distractions. You didn't just write faster, you wrote better.
With your magical typewriter, you never worried about layout. The book formatted itself.
You could hit a key on your magical typewriter to create an ebook from your manuscript with one click.
All ebook formats would be created, and they'd all look good. You'd have PDF for computers, MOBI for Kindle, and EPUB for everywhere else. The book would look great on phones.
With your magical typewriter, you could publish your book before it was even done, and get feedback from readers all over the world. You could automatically share book updates with them. You would press one key on your magical typewriter to publish a new version, and all your readers would have it instantly.
With your magical typewriter, you could easily compare your current manuscript to any other version of your manuscript that had ever existed.
When the book was done, if you decided to make a print book, you could press a key on your magical typewriter to generate InDesign with one click. Your designer or publisher could use this as a starting point for producing a great looking print book.
With your magical typewriter, you'd only have to do one thing: Write.
Wouldn't it be great if such a magical typewriter existed?
It does. At Leanpub, we're building it.
But there's one requirement for this magical typewriter to exist: a simple, coherent, open source, free, plain text format for a book manuscript.
This simple format is what authors will write their books in, instead of Word. It will enable an ecosystem of tools to emerge around it.
This simple format will be the basis for the magical typewriter.
This simple format is called Markua.
This is its user manual.
About the Author
Bundles that include this book
Table of Contents
-
Introduction
- The Magical Typewriter
- How to Write a Novel in Markua
- How to Write a Computer Programming Book in Markua
- How to Write a Course (MOOC) in Markua
- Markua: Markdown for Books and Courses
- Why the Name “Markua”?
- The Markua Manual vs. The Markua Spec
- Markua 0.10 and Markua 0.29
- Differences with Leanpub Flavoured Markdown (LFM)
- Acknowledgments
- Text Formatting
- Headings
- Paragraphs and Blank Lines
-
Resources
-
Resource Insertion Methods
- Figures
- Spans
- Inserting Resources Into a Span Context
-
Resource Locations
- Local Resources
- Web Resources
- Inline Resources
-
Resource Types and Formats
- Images
- Video
- Audio
- Code
- Math
- Tables
-
Resource Insertion Methods
-
Whitespace: Spaces, Tabs and Newlines
-
Newlines
- Single Newline = Forced Line Break
- Three or More Newlines = Two Newlines = One Blank Line
- One Blank Line Is Added When Concatenating Manuscript Files
- All Blank Lines at the Beginning and End of a File are Removed
-
Spaces and Tabs
- Spaces and Tabs at the Beginning of a Line are Only to Determine List Containment, and Extra Spaces are Removed
- Spaces and Tabs at the End of a Line are Removed
- Internal Spaces are Collapsed to One Space, Except At the End of Sentences
-
Newlines
- Lists
- Definition Lists
-
Block Elements
-
Scene Breaks (
* * *) -
Blockquotes (
>) -
Asides (
A>or{aside}) -
Blurbs (
B>or{blurb})- Supported Attributes for Blurbs
-
Syntactic Sugar for Specific Blurb Classes:
D>,E>,I>,Q,T,W>,X> -
Using Blurbs to Center Text with
C> -
Using Extension Attributes on Blurbs to add
iconSupport
-
Scene Breaks (
-
Quizzes and Exercises
- Quiz and Exercise Headings and Other Content
- An Empty Quiz or Exercise is Not an Error
- A Malformed Quiz or Exercise is an Error
- Supported Attributes on Quizzes and/or Exercises
-
Question Types: Multiple Choice, Fill In The Blank
- Multiple Choice Questions
- Fill In The Blank Questions
- Creating a Course or MOOC from a Markua Document
- Question Alternates
-
Span Elements
-
Links
- Inline Links
- Automatic Links
-
Explicitly Creating Spans with
[…]- Sometimes a Square Bracket is Just a Square Bracket
-
Footnotes and Endnotes
- Footnotes
- Endnotes
- Single Reference to Footnotes and Endnotes
- Footnotes and Endnotes Support Required for Paragraphs Only
-
Crosslinks and ids
- Defining an id
-
Referencing an
idWith a Crosslink -
Rules for
ids and Crosslinks
-
Character Substitution (
X--for X—,X --for X –,...for …)- Optional Automatic Curly Quotes Outside of Code Blocks and Spans
-
Escaping Special Characters with Backslash (
\) -
Code Spans and Backticks (
`)
-
Links
-
Metadata
-
Attributes
- Attribute List Format
- Attribute Keys
- Attribute Values
-
idAttributes -
Conditional Inclusion Attributes on Headings:
book,sample
- Directives
- Page Breaks
-
Attributes
-
Appendices
- No Inline HTML
- Differences with Markdown
Authors have earned$10,321,882writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
Continuous Delivery Pipelines
Dave FarleyThis practical handbook provides a step-by-step guide for you to get the best continuous delivery pipeline for your software.
- #2
Top 20 Digital Health Trends For The Near Future
Dr. Bertalan MeskoDigital technology could help transform unsustainable healthcare systems, provide cheaper, faster, and more effective solutions for diseases – and could lead to healthier individuals living in healthier communities.
In this book, we analyze the top 20 trends shaping the future of healthcare, and what they all look like in practice.
- #3
The Hundred-Page Machine Learning Book
Andriy BurkovEverything you really need to know in Machine Learning in a hundred pages.
- #4
Introducing EventStorming
Alberto BrandoliniThe deepest tutorial and explanation about EventStorming, straight from the inventor.
- #5
Atomic Kotlin
Bruce Eckel and Svetlana IsakovaFor both beginning and experienced programmers! From the author of the multi-award-winning Thinking in C++ and Thinking in Java together with a member of the Kotlin language team comes a book that breaks the concepts into small, easy-to-digest "atoms," along with exercises supported by hints and solutions directly inside IntelliJ IDEA!
- #6
C++20
Rainer GrimmC++20 is the next big C++ standard after C++11. As C++11 did it, C++20 changes the way we program modern C++. This change is, in particular, due to the big four of C++20: ranges, coroutines, concepts, and modules.
- #7
CCIE Service Provider Version 4 Written and Lab Exam Comprehensive Guide
Nicholas RussoThe service provider landscape has changed rapidly over the past several years. Networking vendors are continuing to propose new standards, techniques, and procedures for overcoming new challenges while concurrently reducing costs and delivering new services. Cisco has recently updated the CCIE Service Provider track to reflect these changes; this book represents the author's personal journey in achieving that certification.
- #8
Hacking your way around in Emacs
Marcin BorkowskiThis is an intermediate textbook on Emacs Lisp. Learn how to write you own commands and make Emacs truly your editor, suited to your needs!
- #9
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #10
Visualise, document and explore your software architecture
Simon BrownA short guide to visualising, documenting and exploring your software architecture.
Top Bundles
- #1
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #2
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #4
9 Books-Bundle: Shut Up and Code!
9 Books
"Shut up and code." Laughter in the audience. The hacker had just plugged in his notebook and started sharing his screen to present his super-smart Python script. "Shut up and code" The letters written in a white literal coding font on black background was the hackers' home screen background mantra. At the time, I was a first-year computer... - #7
Practical Foundations of Debugging, Disassembling, Reversing
2 Books
The books teach assembly language foundations necessary for deep debugging and program reconstruction. They are useful for: - Software technical support and escalation engineers; - Software engineers coming from different backgrounds, OS, and programming/debugging environments; - Software testers; - C/C++ software engineers without assembly... - #8
Software Architecture and Design Practice Reference
2 Books
Dive deeper in Software Architecture with the Design Practice Reference. Learn all about software architecture and design from the books in this bundle:Software Architecture covers topics from quality attributes to designing and modeling components, interfaces, connectors, and containers, all the way to services and microservices. The Design... - #10
Mastering Containers
2 Books
Docker and Kubernetes are taking the world by storm! These books will get you up-to-speed fast! Docker Deep Dive is over 400 pages long, and covers all objectives on the Docker Certified Associate exam.The Kubernetes Book includes everything you need to get up and running with Kubernetes!
