diff --git a/.gitbook/assets/1.png b/.gitbook/assets/1.png new file mode 100644 index 0000000..2dadf07 Binary files /dev/null and b/.gitbook/assets/1.png differ diff --git a/.gitbook/assets/2.png b/.gitbook/assets/2.png new file mode 100644 index 0000000..01ae5e3 Binary files /dev/null and b/.gitbook/assets/2.png differ diff --git a/.gitbook/assets/3.png b/.gitbook/assets/3.png new file mode 100644 index 0000000..a433dfc Binary files /dev/null and b/.gitbook/assets/3.png differ diff --git a/.gitbook/assets/4.png b/.gitbook/assets/4.png new file mode 100644 index 0000000..c1f1b5d Binary files /dev/null and b/.gitbook/assets/4.png differ diff --git a/README.md b/README.md new file mode 100644 index 0000000..20d4f6c --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +--- +cover: https://gitbookio.github.io/onboarding-template-images/header.png +coverY: 0 +layout: + cover: + visible: true + size: full + title: + visible: true + description: + visible: false + tableOfContents: + visible: true + outline: + visible: true + pagination: + visible: true +--- + +# Welcome + +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. + +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. + +### Jump right in + +
Getting StartedCreate your first site1.pngquickstart.md
BasicsLearn the basics of GitBook2.pngBroken link
Publish your docsShare your docs online3.pngpublish-your-docs.md
diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 0000000..330ab3c --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,17 @@ +# Table of contents + +* [Welcome](README.md) + +## Getting Started + +* [Quickstart](getting-started/quickstart.md) +* [Publish your docs](getting-started/publish-your-docs.md) + +## Basics + +* [Editor](basics/editor.md) +* [Markdown](basics/markdown.md) +* [Images & media](basics/images-and-media.md) +* [Interactive blocks](basics/interactive-blocks.md) +* [OpenAPI](basics/openapi.md) +* [Integrations](basics/integrations.md) diff --git a/basics/editor.md b/basics/editor.md new file mode 100644 index 0000000..cbeab22 --- /dev/null +++ b/basics/editor.md @@ -0,0 +1,11 @@ +# Editor + +GitBook has a powerful block-based editor that allows you to seamlessly create, update, and enhance your content. + +
+ +### Writing content + +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. + +Either start typing below, or press `/` to see a list of the blocks you can insert into your page. diff --git a/basics/images-and-media.md b/basics/images-and-media.md new file mode 100644 index 0000000..1e38e99 --- /dev/null +++ b/basics/images-and-media.md @@ -0,0 +1,9 @@ +# Images & media + +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. + +

Add alt text and captions to your images

+ +{% hint style="info" %} +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. +{% endhint %} diff --git a/basics/integrations.md b/basics/integrations.md new file mode 100644 index 0000000..3e95e1a --- /dev/null +++ b/basics/integrations.md @@ -0,0 +1,9 @@ +# Integrations + +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. + +
+ +### Types of integrations + +
AnalyticsTrack analytics from your docshttps://www.gitbook.com/integrations#analytics2.png
SupportAdd support widgets to your docshttps://www.gitbook.com/integrations#support3.png
InteractiveAdd extra functionality to your docshttps://www.gitbook.com/integrations#interactive4.png
Visitor AuthenticationProtect your docs and require sign-inhttps://www.gitbook.com/integrations#visitor-authentication1.png
diff --git a/basics/interactive-blocks.md b/basics/interactive-blocks.md new file mode 100644 index 0000000..318a1dc --- /dev/null +++ b/basics/interactive-blocks.md @@ -0,0 +1,46 @@ +# Interactive blocks + +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. + +
+ +### Tabs + +{% tabs %} +{% tab title="First tab" %} +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. +{% endtab %} + +{% tab title="Second tab" %} +Add images, embedded content, code blocks, and more. + +```javascript +const handleFetchEvent = async (request, context) => { + return new Response({message: "Hello World"}); +}; +``` +{% endtab %} +{% endtabs %} + +### Expandable sections + +
+ +Click me to expand + +Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-by-step guides and FAQs. + +
+ +### Drawings + + + +### Embedded content + +{% embed url="https://www.youtube.com/watch?v=YILlrDYzAm4" %} + +{% hint style="info" %} +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). +{% endhint %} + diff --git a/basics/markdown.md b/basics/markdown.md new file mode 100644 index 0000000..965c75c --- /dev/null +++ b/basics/markdown.md @@ -0,0 +1,22 @@ +# Markdown + +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! + +
+ +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. + +```markdown +# Heading + +This is some paragraph text, with a [link](https://docs.gitbook.com) to our docs. + +## Heading 2 +- Point 1 +- Point 2 +- Point 3 +``` + +{% hint style="info" %} +If you have multiple files, GitBook makes it easy to import full repositories too — allowing you to keep your GitBook content in sync. +{% endhint %} diff --git a/basics/openapi.md b/basics/openapi.md new file mode 100644 index 0000000..ec2db1d --- /dev/null +++ b/basics/openapi.md @@ -0,0 +1,11 @@ +# OpenAPI + +You can sync GitBook pages with an OpenAPI or Swagger file or a URL to include auto-generated API methods in your documentation. + +### OpenAPI block + +GitBook's OpenAPI block is powered by [Scalar](https://scalar.com/), so you can test your APIs directly from your docs. + +{% swagger src="https://petstore3.swagger.io/api/v3/openapi.json" path="/pet" method="post" %} +[https://petstore3.swagger.io/api/v3/openapi.json](https://petstore3.swagger.io/api/v3/openapi.json) +{% endswagger %} diff --git a/getting-started/publish-your-docs.md b/getting-started/publish-your-docs.md new file mode 100644 index 0000000..1d4ef04 --- /dev/null +++ b/getting-started/publish-your-docs.md @@ -0,0 +1,7 @@ +# Publish your docs + +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. + +You can publish your site and find related settings from your docs site's homepage. + +
diff --git a/getting-started/quickstart.md b/getting-started/quickstart.md new file mode 100644 index 0000000..7b156fc --- /dev/null +++ b/getting-started/quickstart.md @@ -0,0 +1,23 @@ +# Quickstart + +
+ +Beautiful documentation starts with the content you create — and GitBook makes it easy to get started with any pre-existing content. + +{% hint style="info" %} +Want to learn about writing content from scratch? Head to the [Basics](https://github.com/GitbookIO/onboarding-template/blob/main/getting-started/broken-reference/README.md) section to learn more. +{% endhint %} + +### Import + +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. + +
+ +
+ +
+ +### Sync a repository + +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.