You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: getting-started/import.md
+20-14Lines changed: 20 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,9 @@ description: >-
7
7
8
8
# Importing content
9
9
10
-
You can migrate and unify existing documentation in GitBook using the import tool. You have the option to import single or multiple pages — or an entire Git repository.
10
+
You can migrate and unify existing documentation in GitBook using the import tool. 
11
+
12
+
You have the option to import single or multiple pages using our built-in import tool — or [an entire Git repository using Git Sync](import.md#import-using-git-sync).
11
13
12
14
## Using the Import Panel
13
15
@@ -34,8 +36,6 @@ If you want to **import multiple pages**, you can upload a ZIP file containing H
34
36
GitBook is Markdown-based, so importing content in Markdown format will yield the best results. If your current tools support exporting in Markdown, we recommend using that format for a smoother import process.
35
37
{% endhint %}
36
38
37
-
38
-
39
39
### The Import panel
40
40
41
41
<figure><imgsrc="../.gitbook/assets/10_01_25_import_modal.svg"alt=""><figcaption><p>The import panel in GitBook.</p></figcaption></figure>
@@ -57,36 +57,42 @@ GitBook currently has the following limits for imported content:
57
57
* The maximum number of pages that can be uploaded in a single import is **20**.
58
58
* The maximum number of files (images etc.) that can be uploaded in a single import is **20**.
59
59
60
+
***
60
61
62
+
## Import using Git Sync
61
63
62
-
## Importing using Git Sync
64
+
For importing large volumes of content into GitBook, we recommend using [Git Sync](git-sync/). Unlike our integrated import tool, Git Sync is better suited for handling larger migrations efficiently.
63
65
64
-
For importing large volumes of content into GitBook, we recommend using Git Sync. Unlike our default import tool, Git Sync is better suited for handling larger migrations efficiently.
66
+
{% hint style="info" %}
67
+
You’ll find the essential steps to import your content below. For more detailed steps and a video demo, head over to our dedicated guide to [importing content into GitBook using Git Sync](https://app.gitbook.com/s/LBGJKQic7BQYBXmVSjy0/product-guides/import-or-migrate-your-content-to-gitbook-with-git-sync).
68
+
{% endhint %}
65
69
66
-
Here are the steps:
70
+
Here’s how to do it:
67
71
68
72
{% stepper %}
69
73
{% step %}
70
-
### Get your content into markdown
74
+
### Convert your content into Markdown
75
+
76
+
GitBook is Markdown-based, so importing content in Markdown format will yield the best results. If your current tools support exporting in Markdown, we recommend using that format for a smoother import process.
71
77
72
-
If your content isn't already in markdown files, we recommend using some scripting or online tools to translate the content.
78
+
If your content isn’t already in Markdown files, we recommend using a script or an online tool to convert your content.
73
79
{% endstep %}
74
80
75
81
{% step %}
76
-
### Organise your content in GitHub or Gitlab
82
+
### Organize your content in GitHub or GitLab
77
83
78
-
When setting up your GitBook site, it's crucial to organize your content in git efficiently. Since git sync occurs at the space level, carefully plan how to group content. Create multiple repositories or folders, ensuring the necessary markdown files are in the correct locations.
84
+
When setting up your GitBook site, it’s crucial to organize your content in your GitHub or GitLab repository efficiently. Since Git Sync occurs at the space level, carefully plan how to group your content. Create multiple repositories or folders, ensuring the necessary Markdown files are in the correct locations.
79
85
{% endstep %}
80
86
81
87
{% step %}
82
-
### Set up spaces and git sync
88
+
### Set up spaces and Git Sync
83
89
84
-
To organize your content, create one or more spaces in GitBook as needed. Install Git sync on these spaces and configure it to synchronize with the appropriate folder or repository set up in step 2. 
90
+
To organize your content, create one or more spaces in GitBook as needed. Install the [GitHub Sync](https://www.gitbook.com/integrations/github-sync) or [GitLab Sync](https://www.gitbook.com/integrations/gitlab-sync) integrations in your organization and configure it for those spaces. You’ll need to synchronize your space with the folder or repository you set up in the previous step. 
85
91
{% endstep %}
86
92
87
93
{% step %}
88
-
### Run git sync with direction GitHub -> GitBook
94
+
### Run Git Sync in the direction GitHub → GitBook
89
95
90
-
When finishing the configuration ensure you select the direction of GitHub -> GitBook. Run the sync.
96
+
When following the configuration process, make sure you select the direction of GitHub → GitBook. This will result in the contents of your folder or repository being pulled from GitHub or GitLab into GitBook.
0 commit comments