Skip to end of metadata
Go to start of metadata

Page under construction

This page is being updated

This document will describe the options for importing content into GitBook. Since there are multiple methods for publishing content on GitBook, the goal of this document is to develop a set of best practices. Because of the scope of such a process, this document will frequently be updated.

It is NOT recommended to add full spaces and pages manually.

Prepared by Doug Trefun,  



Using the Import Option



GitBook allows for 12 different file types to be used as importable content:

  • Website
  • Markdown
  • Word
  • HTML
  • ZIP
  • Confluence
  • Notion
  • GitHub Wiki
  • Quip
  • Dropbox Paper
  • Google Docs
  • OpenAPI

Because GitHub and GitBook are connected (or should be), the use of Markdown is recommended. This allows for easier imports, editing, formatting, structuring spaces, and version control.


Before you import....

While it's entirely possible to use formats like Word to import content. If you are adding multiple pages that break down into sections and require some level of structure, it is important to start with the right type of document. Using Markdown (md) files allows GitBook to automatically structure and format a space into desired sections using a summary file.

It is a lot easier to start out with the correct format, or a format that is compatible to being converted into markdown. Or just use markdown.


https://docs.gitbook.com/tour/editor/markdown

https://commonmark.org/help/


A Summary File....

This is an example of the OpenHIE Specification summary.md file.


This file lists the other files within the folder in the order that it should be published and what sections the content should be in. 



  • No labels