Skip to content

Migrating LoopBack Docs to Markdown for use with Jekyll

Rand McKinney edited this page Apr 15, 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.
  4. Edit md files to make images show up properly.
  5. Commit .md and image files to repo.

NOTE: It might be better 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:

Now, all the articles are in the repo in markdown. Next we need to create the organization/navigation:

  1. Create directories for the navigation hierarchy. We could leave them all in one dir, but easier to manage and work with if organized into multiple dirs.
  2. Figure out best way to implement navigation. Should it be a side-nav as it is currently, or some kind of top-of-the-page menu system as on http://expressjs.com?

References:

Clone this wiki locally