YAML front matter in Typora

-

    I was looking for ways to add a cover page, header, and footer in Markdown and just figured out how we do it in Typora Markdown editor. It is easy. Set the header and footer using YAML Front Matter.

The YAML front matter must be the first thing in the file and must be valid YAML, set between triple-dashed lines. 

Source: https://support.typora.io/

The following is an example for setting the document title, header, and footer using YAML:

---

title: Agile Technical Documentation

header: A Quick Guide for Agile Technical Documentation

footer: ${pageNo}

---

Apart from this, you need to make a few PDF export settings.

Select File > Preferences > Export > PDF and select the checkbox for Read and overwrite export settings from YAMAL front matters.

Now, the document exported into PDF will have A Quick Guide for Agile Technical Documentation in its header and page number in its footer.

If you need a cover page as well for the PDF export, paste the following content in the Append Extra Content (HTML) field:

<meta name="title" content="${title}"> <div id='_export_cover' style="height:100vh;"> <div id='_export_title' style="margin-top: 25%;text-align: center;font-size: 3rem;"> </div> </div> <script> var $cover = document.querySelector("#_export_cover"); var title = document.querySelector("meta[name='title']").getAttribute("content"); if(!title || title == "${title}") { // no title $cover.remove(); } else { document.body.insertBefore($cover, document.body.childNodes[0]) $cover.querySelector("#_export_title").textContent = title; } </script>

The document exported to PDF will have a cover page with Agile Technical Documentation in its title.
For more information, see:
The ability to learn is the key to survival. We can learn faster by learning from each other.

Comments

Post a Comment

Popular posts from this blog

Apply Goldilocks principle

-
Image
     There is one thing universal about successful managers. They keep increasing the performance benchmark every time. It applies to an athletic coach who wants to make his trainee globally competitive. I have worked under cruelly kind managers who are very ruthless in getting the tasks done. They push you to improve your competency and skills every day. You may have had a tough time working under this manager, and still, it is not something to be resented. Weathers the pressures work? We start looking for ways to do things better when the competitive edge is so narrow, and even a marginal improvement in something will give you an edge over your competitors. I had my dilemmas over if harsh managers are good or bad. A good manager sets difficult but attainable benchmarks and allows members to execute tasks with relative autonomy. There is no use flogging a dead horse. Spend time grooming the people who are motivated to do their best. I have spent time with people who do not have enough
Read more

More effective team meetings

-
Image
     For years and years, I have attended countless number idle team meetings. Sometimes they happen to be recurring meetings without a clear agenda. Generally, I carried a notebook and pencil for the team meeting, and most members did the same as not doing so will look impolite. Someone asked to take the meeting notes will ping the members even after the meeting to help recount the discussion. It is harder to timebox a discussion and measure the outcomes this way. A good plan will make the meeting more effective. It also helps maintain the focus. Identify what you need to do before, during, and after the meeting. The one conducting the meeting should track the tasks against each person in an Excel spreadsheet or a Confluence page. Mark the progress of the tasks during the meeting with inputs from the members. If we need to discuss individual contributions, we can have a PowerPoint presentation with one slide for each member. The same approach can work for discussing new updates and fe
Read more