Skip to content

A repository that shows how we translate every content block to markdown.

Notifications You must be signed in to change notification settings

GitbookIO/git-sync-normalization

Folders and files

NameName
Last commit message
Last commit date

Latest commit

942aa57 · Sep 16, 2022

History

32 Commits
Sep 15, 2022
Sep 6, 2021
Jan 25, 2021
Sep 15, 2022
Nov 25, 2021
Sep 6, 2022
Mar 4, 2022
Sep 15, 2022
Nov 25, 2021
Nov 25, 2021
Sep 6, 2022
Sep 16, 2022
Jan 25, 2021
Jan 25, 2021
Jan 27, 2021
Jan 25, 2021
Jan 25, 2021
Nov 25, 2021
Feb 26, 2021

Repository files navigation

description
All content blocks and how we translate them to markdown

Git Sync

When GitBook exports one of your spaces to a GitHub repository, it translates all content to markdown. GitBook is opinionated. If there are different ways to express the same concept or style in markdown, GitBook will only use one.

For example, in markdown you can have an unordered list start with a - or a *. Both are valid characters for a bullet list. GitBook, however, will always default to *.

If your repository has markdown content that uses -, GitBook will change that to * during the synchronization that happens from GitBook to GitHub.

If you add new content or change existing content to use markup that's not GitBook's flavor, GitBook will change it back at the next opportunity.

This space has examples of all content blocks and how those are translated as markdown content.

This is the repository this space is synched with:

{% embed url="https://github.com/GitbookIO/git-sync-normalization" %}