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.
- 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)
- Text Formatting
- Paragraphs and Blank Lines
Resource Insertion Methods
- Inserting Resources Into a Span Context
- Local Resources
- Web Resources
- Inline Resources
Resource Types and Formats
- Resource Insertion Methods
Whitespace: Spaces, Tabs and 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
- Definition Lists
Scene Breaks (
* * *)
- Supported Attributes for Blurbs
Syntactic Sugar for Specific Blurb Classes:
Using Blurbs to Center Text with
Using Extension Attributes on Blurbs to add
- 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
- Inline Links
- Automatic Links
Explicitly Creating Spans with
- Sometimes a Square Bracket is Just a Square Bracket
Footnotes and Endnotes
- Single Reference to Footnotes and Endnotes
- Footnotes and Endnotes Support Required for Paragraphs Only
Crosslinks and ids
- Defining an id
idWith a Crosslink
ids and Crosslinks
Character Substitution (
X --for X –,
- Optional Automatic Curly Quotes Outside of Code Blocks and Spans
Escaping Special Characters with Backslash (
Code Spans and Backticks (
- Attribute List Format
- Attribute Keys
- Attribute Values
Conditional Inclusion Attributes on Headings:
- Page Breaks
- No Inline HTML
- Differences with Markdown
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.
Ansible for KubernetesJeff Geerling
Ansible is a powerful infrastructure automation tool. Kubernetes is a powerful application deployment platform. Learn how to use these tools to automate massively-scalable, highly-available infrastructure.
Functional Design and ArchitectureAlexander Granin
Software Design in Functional Programming, Design Patterns and Practices, Methodologies and Application Architectures. How to build real software in Haskell with less efforts and low risks. The first complete source of knowledge.
Production HaskellMatt Parsons
Are you excited about Haskell, but don't know where to begin? Are you thrilled by the technical advantages, but worried about the unknown pitfalls? This book has you covered.
Ansible for DevOpsJeff Geerling
Ansible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
Tame your Work FlowSteve Tendon and Daniel Doiron
Do you need a high performance enterprise governance approach improving management, execution and delivery while dealing with multiple projects/products, events, stakeholders and teams? Giving you better bottom line results, faster time to market, less work, better predictability, happier employees, and delighted clients? Then learn about TameFlow!
Practical FP in Scala: A hands-on approachGabriel Volpe
A practical book aimed for those familiar with functional programming in Scala who are yet not confident about architecting an application from scratch.
Together, we will develop a purely functional application using the best libraries in the Cats ecosystem, while learning about design patterns and best practices.
Composing SoftwareEric Elliott
All software design is composition: the act of breaking complex problems down into smaller problems and composing those solutions. Most developers have a limited understanding of compositional techniques. It's time for that to change.
Algebra-Driven DesignSandy Maguire
A how-to field guide on building leak-free abstractions and algebraically designing real-world applications.
Invest In Digital Health - The Medical Futurist's GuideDr. Bertalan Mesko
Artificial Intelligence and Digital Health are booming. In this book, we explain why now it's a good time to invest in Digital Health and give recommendations on where to invest by looking at the top 24 technological trends we find the most promising.
The Hundred-Page Machine Learning BookAndriy Burkov
Everything you really need to know in Machine Learning in a hundred pages.
The Tester's Library
8 BooksThe Tester's Library consists of eight five-star books that every software tester should read and re-read. As bound books, this collection would cost over $200. Even as e-books, their price would exceed $80, but in this bundle, their cost is only $49.99. Here are the books, and why they should be in your library: Perfect Software and Other...
11 BooksIn this bundle, you will find 10 different agile books. They are about different aspects of being agile. - finding a job - doing coding dojo's - Retrospectives - Personal kanban - a non-typical coaching book and even a book that gives you an insight in the lives of some agile people.
WTFlop 6M + HU - Beta Bundle
Marionette.js A to Z
Build A Better Backbone App
3 BooksThe best way to learn new development skills is through experience, but that takes time you don't have.Get the best of both worlds with this bundle: you'll learn how to produce modern web applications by learning from experienced developers like Derick Bailey and David Sulc. BackboneJS is one of the favorite tools on the web today, but it...
General Systems Thinker Bundle
5 BooksThe General Systems Thinker Bundle is just that: a bundle of five books to advance the reader one giant step toward improved thinking, based on General Systems principles. Four of the books are the complete General Systems Series. The fifth is fictional piece which shows some general systems thinkers in action. It's a mystery in which a group of...
Experiential Learning Bundle
4 BooksThis bundle provides all four volumes of the popular Experiential Learning Series at a savings of $20 over the price if purchased separately.
2 BooksAfter getting up and running with Ansible in Jeff Geerling's Ansible for DevOps, strengthen your skills managing tens to thousands of instances and services in Amazon's AWS cloud with Yan Kurniawan's Ansible for AWS.
Learn ECMAScript 6 inside and out
2 BooksFor any technology, it helps to get multiple points of view on the functionality to get the best possible understanding. For ECMAScript 6/2015, no two resources are recommended more frequently thanExploring ES6by Dr. Axel Rauschmayer andUnderstanding ECMAScript 6by Nicholas C. Zakas. These two points of view, investigating the specification and...
NetBeans Platform Starter Kit
2 BooksIn this bundle, you get a complete introduction to the NetBeans Platform APIs, together with many exercises, in the form of "NetBeans Platform for Beginners". This book is done and has been reviewed and is over 350 pages in length. It will continue to grow as more content is added over time. There will be monthly updates, with new sections,...