Faq

Readable Human Format | User Guide

To receive updates nofitification once a month, don't forget to subscribe to our mailing list at the bottom.

Questions / Answers

How to get started

To get started see article:

Getting Started with Readable Human Format

How to add a table

For markdown-gen use table markdown syntax inside text. For html-gen, use html syntax in text. In the future, we may create a table tag for better productivity than writing markdown or html table.

How to add a subscription form to ReAdABLE human format document

This is how easy it is to add, for example, this mailchimp subscription popup form:


<script type="text/javascript" src="//downloads.mailchimp.com/js/signup-forms/popup/unique-methods/embed.js" data-dojo-config="usePlainJson: true, isDebug: false"></script><script type="text/javascript">window.dojoRequire(["mojo/signup-forms/Loader"], function(L) { L.start({"baseUrl":"mc.us20.list-manage.com","uuid":"363b40a4db743ba4ef5a555a3","lid":"f99b32278c","uniqueMethods":true}) })</script>
    

just create a text block with the mailchimp code inside:


.text: {
<script type="text/javascript" src="//downloads.mailchimp.com/js/signup-forms/popup/unique-methods/embed.js" data-dojo-config="usePlainJson: true, isDebug: false"></script><script type="text/javascript">window.dojoRequire(["mojo/signup-forms/Loader"], function(L) { L.start({"baseUrl":"mc.us20.list-manage.com","uuid":"363b40a4db743ba4ef5a555a3","lid":"f99b32278c","uniqueMethods":true}) })</script>    
}
    

the readable source of this guide contains an even more complex subscription form:


Subscribe: [
    .title: {Subscribe to our mailing list}
    .sub-title: {To receive update news once a month}
    .text: {Just click below:
    <br><br><button id='open-popup' style='background:red;color: white;cursor:pointer;font-size: 14px;text-align: center;text-decoration: none;border: none;border-radius: 3px;padding: 13px 32px;font-family:Helvetica Neue,Arial,Helvetica,Verdana,sans-serif' >Subscribe to our mailing list</button>
    }
    .text: {
	<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>

<script type="text/javascript" src="//s3.amazonaws.com/downloads.mailchimp.com/js/signup-forms/popup/embed.js" data-dojo-config="usePlainJson: true, isDebug: false"></script>

<script>
function showMailingPopUp() {
    require(["mojo/signup-forms/Loader"], function(L) { L.start({"baseUrl":"mc.us20.list-manage.com","uuid":"363b40a4db743ba4ef5a555a3","lid":"f99b32278c"}) })
    document.cookie = "MCPopupClosed=; expires=Thu, 01 Jan 1970 00:00:00 UTC";
};

document.getElementById("open-popup").onclick = function() {showMailingPopUp()};
</script>
    }
]
    

How to add Google Analytics ReAdABLE human format document

Currently adding script into html header is not accessible for content writer. It should be added later during the process of generating the complete html page: we'll see how to in the next future tutorial. Don't forget to subscribe to our mailing list to get notified of our tutorial on Google Analytics inclusion. If there are enough demand, we may add create a text /header refinement to be able to add to insert script into header easily.

Can I split a long file into multiple files

Readable is made for large documentation or book, so it is part of its spec. To do so, split content into multiple sections wrapped with [] and put each of them in a file, then adapt the build script, like this for example:


do https://readable.red

article: copy []
foreach file read %parts/ [
    append article load rejoin [%parts/ file]
]
html-gen/output %getting-started.html
    

Links

Related links

Getting started | readable.red

Subscribe to our mailing list

To receive update news once a month

Just click below: