Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 3.24 KB

README.md

File metadata and controls

80 lines (56 loc) · 3.24 KB
Raw

Confluence to Markdown converter

Forked from confluence-to-markdown and updated to ES from CoffeeScript Tests are still WIP

Convert Confluence HTML export to markdown with optional frontmatter for static site generators

Dependencies

Install the pandoc command line tool

pandoc --version

Installing and running

Install all project dependencies:

npm ci

To see the CLI options, execute confluence2md

Usage: confluence2md [options] <sourcePath> <outputPath>

CLI to convert Confluence HTML to mardown for static sites

Arguments:
  sourcePath         Path to exported Confluence HTML
  outputPath         Path to write markdown

Options:
  -f, --frontmatter  Add frontmatter for static site generators
  -h, --help         display help for command

Parameters

parameter description
<pathResource> File or directory to convert with extracted Confluence export
<pathResult> Directory to where the output will be generated to. Defaults to current working directory

Process description

  • Confluence page IDs in HTML file names and links are replaced with that pages' heading
  • overall index.md is created linking all Confluence spaces - their indexes
  • images and other inserted attachments are linked to generated markdown
    • whole images and attachments directories are copied to resulting directory
      • there is no checking done whether perticular file/image is used or not
  • markdown links to internal pages are generated without the trailing .md extension to comply to [] expectations
  • the pandoc utility can accept quite a few options to alter its default behavior
    • those can be passed to it by adding them to @outputTypesAdd, @outputTypesRemove, @extraOptions properties in the App.coffee file
    • or you can send a PR ;)
    • here is the list of options pandoc can accept

Export to HTML

Note that if the converter does not know how to handle a style, HTML to Markdown typically just leaves the HTML untouched (Markdown does allow for HTML tags).

Step by step guide for Confluence data export

  1. Go to the space and choose Space tools > Content Tools on the sidebar.
  2. Choose Export. This option will only be visible if you have the Export Space permission.
  3. Select HTML then choose Next.
  4. Decide whether you need to customize the export:
    • Select Normal Export to produce an HTML file containing all the pages that you have permission to view.
    • Select Custom Export if you want to export a subset of pages, or to exclude comments from the export.
  5. Extract zip

WARNING
Please note that Blog will NOT be exported to HTML. You have to copy it manually or export it to XML or PDF. But those format cannot be processed by this utility.

[]: https://github.com/jgm//