Markdown guide
- Published on: 20 July 2018
- Last updated on: 20 July 2018
- Banner image
- Biography
- Block quote
- Contact us
- Document
- Emphasis
- Headings
- Heading H1
- Heading H2
- Horizontal line
- Images
- Jumpbox
- Links
- Lists
- Locations
- Roles
- Section Guide
- Tables
- Table of Contents
- Updates
- Youtube video
Banner image
On a Campaign Page this will fill the full width of the screen. On other pages it inserts the image as the width of the main text column. Note that a banner image automatically includes a gold line across the bottom of the image.
In a new row, start typing "[banner" and it will bring up a list of uploaded images. Select the relevant uploaded images. Click "Add" to add the image to your content.
Use | [banner id ] |
Parameter 'id' | Id of uploaded file |
Biography
Links to a Biography page of a Minister or senior civil servant.
Use | [biography name ] |
Parameter 'name' | Name of uploaded file (choose from list) |
Block quote
Start your row with ">" to style a paragraph as a quote.
Use | > paragraph |
Parameter 'paragraph' | Type text directly after the > |
Contact us
Creates a 'contact us' box with department phone number, email and postal addresses.
In a new row, start typing "[contact-us" and it will bring up a list of uploaded details. Select the relevant uploaded images. Click "Add" to add the image to your content.
$sectionDocument
Document
Inserts a document into content.
In a new row, start typing "[document" and it will bring up a list of uploaded documents. Select the relevant uploaded documents. Click "Add" to add it to your content.
This document will appear as a file preview with the option to open or download it.
Use | [document id] |
Parameter 'id' | Id of uploaded file |
Emphasis
To mark text as bold, put “**” immediately before and after the text. Use sparingly. This can be used in tables to highlight a row as the table header.
Use | **text** |
Parameter 'text' | Any text that you want to style |
Headings
Formats text as a heading. Note that you should only use H2 or H3 when formatting content.
Heading H1
Heading H1 is used only in the campaign index page (homepage). All other templates on the website automatically format the page title in H1. Do not use H1 titles in content as this affects search engine results.
Use | # text |
Parameter 'text' | Text of heading |
Heading H2
Use for major headings in the text.
In a long text with three or more H2 headings a Table of Contents will automatically appear.
Use | ## text |
Parameter 'text' | Text of heading |
Heading H3
Use for subheadings in text.
Use | ### text |
Parameter 'text' | Text of heading |
Heading H4
Use for subheadings win text without including a horizontal line.
Use | #### text |
Parameter 'text' | Text of heading |
Horizontal line
Inserts a horizontal line across the width of the published content.
In a new row, type "***"
Use | *** |
Images
Inserts an image into content.
In a new row, start typing "[image" and it will bring up a list of uploaded images. Select the relevant uploaded images. Click "Add" to add the image to your content.
This image will appear in original size, if the original size width is wider than the space on the page, the image will be scaled down to fit.
Use | [image id ] |
Parameter 'id' | Id of uploaded file |
Jumpbox
A jumpbox is a widget with a square image and a title text underneath that can be used as a link to any page on Gov.ie or on external websites.
In a new row start typing "[jumpbox" and it will bring up a list of uploaded images. Select the relevant uploaded image. Add the text for the link and the url of the link. Click "Add" to add the image to your content.
Note that the image must be square (ratio 1:1)
You can have up to 3 jumpboxes in a row.
Use | [jumpbox | id | url | text | alt ] |
Parameter 'id' | Id of uploaded file |
Parameter 'url' | Redirect URL |
Parameter 'text' | Text to display under placeholder image |
Parameter 'alt' | Alternative text for image and link |
Links
Link to another webpage
Type "[external-link" and enter title and url in the pop-up box and click ‘add’. Links can be used in any part of the content.
Use | [external-link | url | text ] |
Parameter 'url' | Redirect URL |
Parameter 'text' | Text to display under placeholder image |
Note: The alt text must be formatted manually in the content.
Type "[internal-link" and enter title and url in the pop-up box and click ‘add’. Links can be used in any part of the content.
Use | [internal-link | url | text ] |
Parameter 'url' | Redirect URL |
Parameter 'text' | Text to display under placeholder image |
Note: The alt text must be formatted manually in the content.
Link to email
To add a working link to an email address type "[email" followed by the email address.
Use | [email | email address ] |
Parameter 'email address' | email address |
Link to a page in a Pdf
Links to a specific page in a pdf document. Link to page 1 if you just want to link to the document without adding it as a separate attachment.
Start typing "[pdf ". This will open a pop-up window allowing you to select an uploaded document, add text for the link and enter in the page number you want the document to open on. This widget can be used anywhere in the content (same as links).
Use | [pdf | id | page | text ] |
Parameter 'id' | Id of uploaded file |
Parameter 'page' | Page of document |
Parameter 'text' | Text of link |
Lists
Currently we only support bulleted lists.
Start each row with "*" followed by the content text.
Links can be bulleted.
Use | * text |
Parameter 'text' | Text of bulleted item |
Locations
In a new row, type "[location". This will open a pop-up window with a list of addresses that have been uploaded to the site. Select the location you want to display from the list.
If you do not want this information or want to alter it you will can edit the title or summary using the CMS update function.
Use | [location id |
Parameter 'id' | Id of location |
Roles
Links to a Role page of a Minister.
Use | [role name] |
Parameter 'name' | Name of position (choose from list) |
Section Guide
The Section Guide allows you to enter several sections of text to a single document. When published, a list of the sections is shown with one section of text visible beneath it. By default this shows the first section. If you click on a different section, the text will show beneath the list of sections.
Use | |
Parameter ‘title' | Title of Section |
Parameter 'text' | Text of each section |
Close section with | '$/' |
Tables
Creates a table in the content.
Note that other markdown instructions can be used within the table, for example, website and email links.
Use | | text | text | text | |
Parameter 'text' | Text of cell |
Table of Contents
Using four or more H2 headings in a document will automatically generate a table of contents at the start of the document.
Use | ##Heading |
Parameter ‘heading' | Title of each paragraph or section |
Updates
Generates a highlighted box for adding updates or other messages to content. Typing ‘[message’ to opens a pop-up window. Enter the text and date in the relevant boxes.
Note you can include links in the message box (see example below).
This message be placed anywhere in content but best used at the top for flagging important updates.
Use | [message | Text | Date of Update ] | |
Parameter 'text' | Text of update | |
Date of update | day-month-year time |
Youtube video
Inserts a video from youtube in the content.
In a new row, start typing "[youtube" and a pop-up box will appear. Insert a youtube video url and click "Add". The Youtube video will take up the full width of the page.
Use | [youtube url ] |
Parameter 'url' | URL of Youtube video |