Author Markdown documents from the Web Editor id223MIE0B079

Markdown is a lightweight markup language that can help you add formatting elements to plain text documents. AEM Guides provides the feature to create, author, and preview a Markdown (.md) topic from the Web Editor. You can also upload the existing Markdown documents and edit them in the Web Editor.

Create a Markdown topic

Perform the following steps to create a Markdown topic from the Web Editor:

  1. Select a folder in the Repository View.

  2. Create Markdown Topic in one of the following ways:

    1. Click Create DITA File icon on the top-right corner of the Repository Panel and then select Markdown Topic from the dropdown.

    {width="550"}

    1. Select Create from the Options menu of the selected folder and then select Markdown Topic from the dropdown.

    {width="550"}

  3. Enter the name and path of the Markdown topic in the Create New Markdown Topic dialog.

  1. Click Create.

The Markdown topic is created at the selected path and is open for editing.

Author and Preview a Markdown topic

Perform the following steps to author a Markdown topic from the Web Editor:

  1. Select an existing Markdown topic(.md) in the Repository View.

  2. Double-click the topic to open it in the editing window.

    The topic opens in Source mode.

  3. Update the content in the Markdown topic.

  4. Click Preview on the top-right to preview the topic.

    note note
    NOTE
    The Preview mode shows how a topic will be displayed when it is viewed by a user in their browser.
  5. Use Save as a New Version in the main toolbar to save the changes you have made in your topic and create a new version of your topic. You can also use Save All in the main toolbar to save your changes in all opened topics.

  6. Click Close on the top-right to close the Markdown topic.

NOTE
If you have not saved changes, a popup is displayed, and you are prompted to save your topic before you close it.

Parent topic:Work with the Web Editor

recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178