-
Notifications
You must be signed in to change notification settings - Fork 386
Migrating LoopBack Docs to Markdown for use with Jekyll
GOAL: To create an open-source site similar to Express docs. High-level tasks:
- 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.) See attachment to issue #29.
- Copy image files to the
/images
directory (ignore sub-folders; put all files at same level). - Process the HTML files, resulting in markdown (
.md
) files. - Add resulting .md files to this repo in the
/pages/lb2
directory (for LoopBack 2). - Manual cleanup.
When site goes live, replace Confluence pages with redirects to here.
NOTE: Although the long-term plan is to have both LoopBack 2.x and 3.0 docs, initially we should focus on 2.x, since 3.0 is not released yet. As the 3.0 release approaches, we can "clone" the 2.0 docs into /docs/lb3
, and then add/modify the content as needed.
For details of how to convert Confluence HTML to markdown, see Conversion rules.
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:
- https://domchristie.github.io/to-markdown/ Online HTML to MD converter.
- http://pandoc.org/
References: