Skip to content

Commit fa19914

Browse files
Adedayo Akinpelugitbook-bot
Adedayo Akinpelu
authored and
gitbook-bot
committed
GitBook: No commit message
1 parent 2e5d5f9 commit fa19914

File tree

9 files changed

+331
-2
lines changed

9 files changed

+331
-2
lines changed

‎docs/README.md‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
# Page
1+
---
2+
icon: hand-wave
3+
layout:
4+
width: default
5+
title:
6+
visible: true
7+
description:
8+
visible: false
9+
tableOfContents:
10+
visible: true
11+
outline:
12+
visible: true
13+
pagination:
14+
visible: true
15+
metadata:
16+
visible: true
17+
metaLinks:
18+
alternates:
19+
- https://app.gitbook.com/s/yE16Xb3IemPxJWydtPOj/
20+
---
221

22+
# Welcome
23+
24+
Welcome to the GitBook starter template! Here you'll get an overview of all the amazing features GitBook offers to help you build beautiful, interactive documentation.
25+
26+
You'll see some of the best parts of GitBook in action — and find help on how you can turn this template into your own.
27+
28+
### Jump right in
29+
30+
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-bolt">:bolt:</i></h4></td><td><strong>Quickstart</strong></td><td>Create your first site</td><td></td><td></td><td><a href="getting-started/quickstart.md">quickstart.md</a></td></tr><tr><td><h4><i class="fa-leaf">:leaf:</i></h4></td><td><strong>Editor basics</strong></td><td>Learn the basics of GitBook</td><td></td><td></td><td><a href="https://github.com/GitbookIO/gitbook-templates/blob/main/product-docs/broken-reference/README.md">https://github.com/GitbookIO/gitbook-templates/blob/main/product-docs/broken-reference/README.md</a></td></tr><tr><td><h4><i class="fa-globe-pointer">:globe-pointer:</i></h4></td><td><strong>Publish your docs</strong></td><td>Share your docs online</td><td></td><td></td><td><a href="getting-started/publish-your-docs.md">publish-your-docs.md</a></td></tr></tbody></table>

‎docs/SUMMARY.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
11
# Table of contents
22

3-
* [Page](README.md)
3+
* [Welcome](README.md)
4+
5+
## Getting Started
6+
7+
* [Quickstart](getting-started/quickstart.md)
8+
* [Publish your docs](getting-started/publish-your-docs.md)
9+
10+
## Basics
11+
12+
* [Editor](basics/editor.md)
13+
* [Markdown](basics/markdown.md)
14+
* [Images & media](basics/images-and-media.md)
15+
* [Interactive blocks](basics/interactive-blocks.md)
16+
* [Integrations](basics/integrations.md)

‎docs/basics/editor.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
icon: pen-to-square
3+
layout:
4+
width: default
5+
title:
6+
visible: true
7+
description:
8+
visible: true
9+
tableOfContents:
10+
visible: true
11+
outline:
12+
visible: true
13+
pagination:
14+
visible: true
15+
metadata:
16+
visible: true
17+
metaLinks:
18+
alternates:
19+
- https://app.gitbook.com/s/yE16Xb3IemPxJWydtPOj/basics/editor
20+
---
21+
22+
# Editor
23+
24+
GitBook has a powerful block-based editor that allows you to seamlessly create, update, and enhance your content.
25+
26+
<figure><img src="https://gitbookio.github.io/onboarding-template-images/editor-hero.png" alt=""><figcaption></figcaption></figure>
27+
28+
### Writing content
29+
30+
GitBook offers a range of block types for you to add to your content inline — from simple text and tables, to code blocks and more. These elements will make your pages more useful to readers, and offer extra information and context.
31+
32+
Either start typing below, or press `/` to see a list of the blocks you can insert into your page.
33+
34+
### Add a new block
35+
36+
{% stepper %}
37+
{% step %}
38+
#### Open the insert block menu
39+
40+
Press `/` on your keyboard to open the insert block menu.
41+
{% endstep %}
42+
43+
{% step %}
44+
#### Search for the block you need
45+
46+
Try searching for “Stepper”, for exampe, to insert the stepper block.
47+
{% endstep %}
48+
49+
{% step %}
50+
#### Insert and edit your block
51+
52+
Click or press Enter to insert your block. From here, you’ll be able to edit it as needed.
53+
{% endstep %}
54+
{% endstepper %}

‎docs/basics/images-and-media.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
icon: image-landscape
3+
layout:
4+
width: default
5+
title:
6+
visible: true
7+
description:
8+
visible: true
9+
tableOfContents:
10+
visible: true
11+
outline:
12+
visible: true
13+
pagination:
14+
visible: true
15+
metadata:
16+
visible: true
17+
metaLinks:
18+
alternates:
19+
- https://app.gitbook.com/s/yE16Xb3IemPxJWydtPOj/basics/images-and-media
20+
---
21+
22+
# Images & media
23+
24+
GitBook allows you to add images and media easily to your docs. Simply drag a file into the editor, or use the file manager in the upper right corner to upload multiple images at once.
25+
26+
<figure><img src="https://gitbookio.github.io/onboarding-template-images/images-hero.png" alt=""><figcaption><p>Add alt text and captions to your images</p></figcaption></figure>
27+
28+
{% hint style="info" %}
29+
You can also add images simply by copying and pasting them directly into the editor — and GitBook will automatically add it to your file manager.
30+
{% endhint %}

‎docs/basics/integrations.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
icon: plug-circle-plus
3+
layout:
4+
width: default
5+
title:
6+
visible: true
7+
description:
8+
visible: true
9+
tableOfContents:
10+
visible: true
11+
outline:
12+
visible: true
13+
pagination:
14+
visible: true
15+
metadata:
16+
visible: true
17+
metaLinks:
18+
alternates:
19+
- https://app.gitbook.com/s/yE16Xb3IemPxJWydtPOj/basics/integrations
20+
---
21+
22+
# Integrations
23+
24+
GitBook integrations allow you to connect your GitBook spaces to some of your favorite platforms and services. You can install integrations into your GitBook page from the _Integrations_ menu in the top left.
25+
26+
<figure><img src="https://gitbookio.github.io/onboarding-template-images/integrations-hero.png" alt=""><figcaption></figcaption></figure>
27+
28+
### Types of integrations
29+
30+
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th></tr></thead><tbody><tr><td><strong>Analytics</strong></td><td>Track analytics from your docs</td><td><a href="https://www.gitbook.com/integrations#analytics">https://www.gitbook.com/integrations#analytics</a></td><td></td><td></td></tr><tr><td><strong>Support</strong></td><td>Add support widgets to your docs</td><td><a href="https://www.gitbook.com/integrations#support">https://www.gitbook.com/integrations#support</a></td><td></td><td></td></tr><tr><td><strong>Interactive</strong></td><td>Add extra functionality to your docs</td><td><a href="https://www.gitbook.com/integrations#interactive">https://www.gitbook.com/integrations#interactive</a></td><td></td><td></td></tr><tr><td><strong>Visitor Authentication</strong></td><td>Protect your docs and require sign-in</td><td><a href="https://www.gitbook.com/integrations#visitor-authentication">https://www.gitbook.com/integrations#visitor-authentication</a></td><td></td><td></td></tr></tbody></table>

‎docs/basics/interactive-blocks.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
icon: hand-pointer
3+
layout:
4+
width: default
5+
title:
6+
visible: true
7+
description:
8+
visible: true
9+
tableOfContents:
10+
visible: true
11+
outline:
12+
visible: true
13+
pagination:
14+
visible: true
15+
metadata:
16+
visible: true
17+
metaLinks:
18+
alternates:
19+
- https://app.gitbook.com/s/yE16Xb3IemPxJWydtPOj/basics/interactive-blocks
20+
---
21+
22+
# Interactive blocks
23+
24+
In addition to the default Markdown you can write, GitBook has a number of out-of-the-box interactive blocks you can use. You can find interactive blocks by pressing `/` from within the editor.
25+
26+
<figure><img src="https://gitbookio.github.io/onboarding-template-images/interactive-hero.png" alt=""><figcaption></figcaption></figure>
27+
28+
### Tabs
29+
30+
{% tabs %}
31+
{% tab title="First tab" %}
32+
Each tab is like a mini page — it can contain multiple other blocks, of any type. So you can add code blocks, images, integration blocks and more to individual tabs in the same tab block.
33+
{% endtab %}
34+
35+
{% tab title="Second tab" %}
36+
Add images, embedded content, code blocks, and more.
37+
38+
```javascript
39+
const handleFetchEvent = async (request, context) => {
40+
return new Response({message: "Hello World"});
41+
};
42+
```
43+
{% endtab %}
44+
{% endtabs %}
45+
46+
### Expandable sections
47+
48+
<details>
49+
50+
<summary>Click me to expand</summary>
51+
52+
Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-by-step guides and FAQs.
53+
54+
</details>
55+
56+
### Embedded content
57+
58+
{% embed url="https://www.youtube.com/watch?v=YILlrDYzAm4" %}
59+
60+
{% hint style="info" %}
61+
GitBook supports thousands of embedded websites out-of-the-box, simply by pasting their links. Feel free to check out which ones[ are supported natively](https://iframely.com).
62+
{% endhint %}

‎docs/basics/markdown.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
icon: markdown
3+
layout:
4+
width: default
5+
title:
6+
visible: true
7+
description:
8+
visible: true
9+
tableOfContents:
10+
visible: true
11+
outline:
12+
visible: true
13+
pagination:
14+
visible: true
15+
metadata:
16+
visible: true
17+
metaLinks:
18+
alternates:
19+
- https://app.gitbook.com/s/yE16Xb3IemPxJWydtPOj/basics/markdown
20+
---
21+
22+
# Markdown
23+
24+
GitBook supports many different types of content, and is backed by Markdown — meaning you can copy and paste any existing Markdown files directly into the editor!
25+
26+
<figure><img src="https://gitbookio.github.io/onboarding-template-images/markdown-hero.png" alt=""><figcaption></figcaption></figure>
27+
28+
Feel free to test it out and copy the Markdown below by hovering over the code block in the upper right, and pasting into a new line underneath.
29+
30+
```markdown
31+
# Heading
32+
33+
This is some paragraph text, with a [link](https://docs.gitbook.com) to our docs.
34+
35+
## Heading 2
36+
- Point 1
37+
- Point 2
38+
- Point 3
39+
```
40+
41+
{% hint style="info" %}
42+
If you have multiple files, GitBook makes it easy to import full repositories too — allowing you to keep your GitBook content in sync.
43+
{% endhint %}

‎docs/getting-started/publish-your-docs.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
icon: globe-pointer
3+
layout:
4+
width: default
5+
title:
6+
visible: true
7+
description:
8+
visible: true
9+
tableOfContents:
10+
visible: true
11+
outline:
12+
visible: true
13+
pagination:
14+
visible: true
15+
metadata:
16+
visible: true
17+
metaLinks:
18+
alternates:
19+
- >-
20+
https://app.gitbook.com/s/yE16Xb3IemPxJWydtPOj/getting-started/publish-your-docs
21+
---
22+
23+
# Publish your docs
24+
25+
Once you’ve finished writing, editing, or importing your content, you can publish your work to the web as a docs site. Once published, your site will be accessible online only to your selected audience.
26+
27+
You can publish your site and find related settings from your docs site's homepage.
28+
29+
<figure><img src="https://gitbookio.github.io/onboarding-template-images/publish-hero.png" alt=""><figcaption></figcaption></figure>

‎docs/getting-started/quickstart.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
icon: bolt
3+
layout:
4+
width: default
5+
title:
6+
visible: true
7+
description:
8+
visible: true
9+
tableOfContents:
10+
visible: true
11+
outline:
12+
visible: true
13+
pagination:
14+
visible: true
15+
metadata:
16+
visible: true
17+
metaLinks:
18+
alternates:
19+
- https://app.gitbook.com/s/yE16Xb3IemPxJWydtPOj/getting-started/quickstart
20+
---
21+
22+
# Quickstart
23+
24+
<figure><img src="https://gitbookio.github.io/onboarding-template-images/quickstart-hero.png" alt=""><figcaption></figcaption></figure>
25+
26+
Beautiful documentation starts with the content you create — and GitBook makes it easy to get started with any pre-existing content.
27+
28+
{% hint style="info" %}
29+
Want to learn about writing content from scratch? Head to the [Basics](../basics/editor.md) section to learn more.
30+
{% endhint %}
31+
32+
### Import
33+
34+
GitBook supports importing content from many popular writing tools and formats. If your content already exists, you can upload a file or group of files to be imported.
35+
36+
<div data-full-width="false"><figure><img src="https://gitbookio.github.io/onboarding-template-images/quickstart-import.png" alt=""><figcaption></figcaption></figure></div>
37+
38+
### Sync a repository
39+
40+
GitBook also allows you to set up a bi-directional sync with an existing repository on GitHub or GitLab. Setting up Git Sync allows you and your team to write content in GitBook or in code, and never have to worry about your content becoming out of sync.

0 commit comments

Comments
 (0)