-
Notifications
You must be signed in to change notification settings - Fork 382
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:
- 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.)
- Convert/strip HTML to markdown using script.
- Get image content from Confluence.
- Edit md files to make images show up properly.
- 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:
- https://domchristie.github.io/to-markdown/ Online HTML to MD converter.
- http://pandoc.org/
Now, all the articles are in the repo in markdown. Next we need to create the organization/navigation:
- 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.
- 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: