Convert Confluence HTML export to Markdown.
Forked from meridius/confluence-to-markdown
You must have pandoc command line tool installed. Check it by running:
pandoc --version
Install all project dependencies:
npm install
In the converter's directory:
npm run start <pathResource> <pathResult>
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 |
- 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
andattachments
directories are copied to resulting directory- there is no checking done whether perticular file/image is used or not
- whole
- markdown links to internal pages are generated without the trailing .md extension to comply to gitit expectations
- this can be changed by finding all occurances of
gitit requires link to pages without .md extension
in the.coffee
files and adding the extension there. - or you can send a PR ;)
- this can be changed by finding all occurances of
- 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 theApp.coffee
file - or you can send a PR ;)
- here is the list of options pandoc can accept
- those can be passed to it by adding them to
- throughout the application a single console logger is used, its default verbosity is set to INFO
- you can change the verbosity to one of DEBUG, INFO, WARNING, ERROR levels in the
Logger.coffee
file - or you can send a PR ;)
- you can change the verbosity to one of DEBUG, INFO, WARNING, ERROR levels in the
- a series of formatter rules is applied to the HTML text of Confluence page for it to be converted properly
- you can view and/or change them in the
Page.coffee
file - the rules themselves are located in the
Formatter.coffee
file
- you can view and/or change them in the
If you happen to find something not to your liking, you are welcome to send a PR. Some good starting points are mentioned in the Process description section above.
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).
- Go to the space and choose
Space tools > Content Tools on the sidebar
. - Choose Export. This option will only be visible if you have the Export Space permission.
- Select HTML then choose Next.
- 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.
- 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.
Thanks to Eric White for a starting point.
Forked from meridius