Skip to content

Migrating LoopBack Docs to Markdown for use with Jekyll

Rand McKinney edited this page Aug 5, 2016 · 16 revisions

To create an open-source site similar to Express docs:

  1. Export content of APIC space to HTML. (This space now contains the source documentation for LoopBack, which is duplicated in pages with the same title in the LB space.)
  2. Convert/strip HTML to markdown using script.
  3. Get image content from Confluence.

Conversion from HTML to markdown

Front matter

Every markdown file must start with some Jekyll front-matter that looks like this:

---
title: LoopBack core concepts
layout: stub
keywords: LoopBack
tags: [getting_started]
sidebar: lb2_sidebar
permalink: /doc/lb2/LoopBack-core-concepts.html
summary:
---

NOTE: The three dashes are required.

Article content

Links

Images

Macros


Note

I'm assuming we can convert the HTML to markdown without too much trouble, but I'm keeping this here for reference in case we need it.

In case it's easier to export to Word and then convert the Word files to markdown. See How can doc/docx files be converted to markdown or structured text?.

Other references:

References: