Writerside Help

Import from Markdown

If you have existing documentation authored in Markdown, you can import it as a new Writerside project or manually add specific Markdown files as topics to your current Writerside project.

Import as new documentation project

  1. In the Welcome to Writerside dialog, click New Project.

    If you already have a project open, select File | New Project from the menu bar.

  2. In the New Project wizard, select Import from MD.

  3. Specify the name and location for your new project.

    In the Copy from field, select the location of your Markdown sources.

    The wizard will show you a list of Markdown files in the selected location. You can choose which files you want to import.

    If you do not want to import images and videos, clear the Copy all media files used in selected Markdown files checkbox.

  4. Click Create.

    Import from MD wizard

Add Markdown files to existing project

If you have some content as Markdown files, you can add them as topics to your existing Writerside project.

  1. In the Table of Contents pane of the Writerside tool window, click Add New Topic and select Add Local Markdown Files.

  2. Select the directory with Markdown files.

  3. In the Add Local Markdown Files dialog, select the files that you want to import as topics and click OK.

Once Markdown files are in your Writerside project, you can use semantic elements and attributes to enhance your topics with Tabs, TLDR blocks, Collapsible elements, and other markup not available in generic Markdown. For more information, see Markup.

Last modified: 16 September 2024