GITBOOK-1: Initialize the site
This commit is contained in:
parent
6a07ff090b
commit
1c8c5238d6
GPG Key ID:
56209E0CCD8420C6
@ -1,29 +1,24 @@
|
|||||||
---
|
---
|
||||||
icon: hand-wave
|
icon: hand-wave
|
||||||
cover: https://gitbookio.github.io/onboarding-template-images/header.png
|
|
||||||
coverY: 0
|
|
||||||
layout:
|
layout:
|
||||||
cover:
|
|
||||||
visible: true
|
|
||||||
size: full
|
|
||||||
title:
|
title:
|
||||||
visible: true
|
visible: true
|
||||||
description:
|
description:
|
||||||
visible: false
|
visible: false
|
||||||
tableOfContents:
|
tableOfContents:
|
||||||
visible: true
|
visible: false
|
||||||
outline:
|
outline:
|
||||||
visible: true
|
visible: false
|
||||||
pagination:
|
pagination:
|
||||||
visible: true
|
visible: false
|
||||||
---
|
---
|
||||||
|
|
||||||
# Welcome
|
# 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.
|
Welcome to the CVSA 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.
|
This doc contains various information about the CVSA project, including technical architecture, tutorials for visitors, etc.
|
||||||
|
|
||||||
### Jump right in
|
### Jump right in
|
||||||
|
|
||||||
<table data-view="cards"><thead><tr><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><strong>Getting Started</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><strong>Basics</strong></td><td>Learn the basics of GitBook</td><td></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><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>
|
<table data-view="cards"><thead><tr><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><strong>About CVSA</strong></td><td>Some information you might want to know about.</td><td></td><td></td><td><a href="./">.</a></td></tr><tr><td><strong>Architecture</strong></td><td>The technical details about how CVSA was built.</td><td></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>API Doc</strong></td><td>Documentation about APIs provided by CVSA.</td><td></td><td></td><td><a href="broken-reference">Broken link</a></td></tr></tbody></table>
|
||||||
|
|||||||
@ -2,16 +2,16 @@
|
|||||||
|
|
||||||
* [Welcome](README.md)
|
* [Welcome](README.md)
|
||||||
|
|
||||||
## Getting Started
|
## About
|
||||||
|
|
||||||
* [Quickstart](getting-started/quickstart.md)
|
* [About CVSA Project](about/this-project.md)
|
||||||
* [Publish your docs](getting-started/publish-your-docs.md)
|
* [Scope of Inclusion](about/scope-of-inclusion.md)
|
||||||
|
|
||||||
## Basics
|
## Architecure
|
||||||
|
|
||||||
* [Editor](basics/editor.md)
|
* [Overview](architecure/overview.md)
|
||||||
* [Markdown](basics/markdown.md)
|
|
||||||
* [Images & media](basics/images-and-media.md)
|
## API Doc
|
||||||
* [Interactive blocks](basics/interactive-blocks.md)
|
|
||||||
* [OpenAPI](basics/openapi.md)
|
* [Catalog](api-doc/catalog.md)
|
||||||
* [Integrations](basics/integrations.md)
|
* [Songs](api-doc/songs.md)
|
||||||
|
|||||||
2
doc/about/scope-of-inclusion.md
Normal file
2
doc/about/scope-of-inclusion.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Scope of Inclusion
|
||||||
|
|
||||||
2
doc/about/this-project.md
Normal file
2
doc/about/this-project.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# About CVSA Project
|
||||||
|
|
||||||
4
doc/api-doc/catalog.md
Normal file
4
doc/api-doc/catalog.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# Catalog
|
||||||
|
|
||||||
|
* [**Songs**](songs.md)
|
||||||
|
|
||||||
2
doc/api-doc/songs.md
Normal file
2
doc/api-doc/songs.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Songs
|
||||||
|
|
||||||
18
doc/architecure/overview.md
Normal file
18
doc/architecure/overview.md
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
icon: globe-pointer
|
||||||
|
layout:
|
||||||
|
title:
|
||||||
|
visible: true
|
||||||
|
description:
|
||||||
|
visible: false
|
||||||
|
tableOfContents:
|
||||||
|
visible: true
|
||||||
|
outline:
|
||||||
|
visible: true
|
||||||
|
pagination:
|
||||||
|
visible: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# Overview
|
||||||
|
|
||||||
|
Automation is the biggest highlight of CVSA's technical design. To achieve this, we use a message queue powered by [BullMQ](https://bullmq.io/) to concurrently process various tasks in the data collection life cycle.
|
||||||
@ -1,38 +0,0 @@
|
|||||||
---
|
|
||||||
icon: pen-to-square
|
|
||||||
---
|
|
||||||
|
|
||||||
# Editor
|
|
||||||
|
|
||||||
GitBook has a powerful block-based editor that allows you to seamlessly create, update, and enhance your content.
|
|
||||||
|
|
||||||
<figure><img src="https://gitbookio.github.io/onboarding-template-images/editor-hero.png" alt=""><figcaption></figcaption></figure>
|
|
||||||
|
|
||||||
### 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.
|
|
||||||
|
|
||||||
### Add a new block
|
|
||||||
|
|
||||||
{% stepper %}
|
|
||||||
{% step %}
|
|
||||||
### Open the insert block menu
|
|
||||||
|
|
||||||
Press `/` on your keyboard to open the insert block menu.
|
|
||||||
{% endstep %}
|
|
||||||
|
|
||||||
{% step %}
|
|
||||||
### Search for the block you need 
|
|
||||||
|
|
||||||
Try searching for “Stepper”, for exampe, to insert the stepper block.
|
|
||||||
{% endstep %}
|
|
||||||
|
|
||||||
{% step %}
|
|
||||||
### Insert and edit your block
|
|
||||||
|
|
||||||
Click or press Enter to insert your block. From here, you’ll be able to edit it as needed.
|
|
||||||
{% endstep %}
|
|
||||||
{% endstepper %}
|
|
||||||
|
|
||||||
@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
icon: image-landscape
|
|
||||||
---
|
|
||||||
|
|
||||||
# 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.
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
{% 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 %}
|
|
||||||
@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
icon: plug-circle-plus
|
|
||||||
---
|
|
||||||
|
|
||||||
# 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.
|
|
||||||
|
|
||||||
<figure><img src="https://gitbookio.github.io/onboarding-template-images/integrations-hero.png" alt=""><figcaption></figcaption></figure>
|
|
||||||
|
|
||||||
### Types of integrations
|
|
||||||
|
|
||||||
<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>
|
|
||||||
@ -1,50 +0,0 @@
|
|||||||
---
|
|
||||||
icon: hand-pointer
|
|
||||||
---
|
|
||||||
|
|
||||||
# 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.
|
|
||||||
|
|
||||||
<figure><img src="https://gitbookio.github.io/onboarding-template-images/interactive-hero.png" alt=""><figcaption></figcaption></figure>
|
|
||||||
|
|
||||||
### 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
|
|
||||||
|
|
||||||
<details>
|
|
||||||
|
|
||||||
<summary>Click me to expand</summary>
|
|
||||||
|
|
||||||
Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-by-step guides and FAQs.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
### Drawings
|
|
||||||
|
|
||||||
<img alt="" class="gitbook-drawing">
|
|
||||||
|
|
||||||
### 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 %}
|
|
||||||
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
---
|
|
||||||
icon: markdown
|
|
||||||
---
|
|
||||||
|
|
||||||
# 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!
|
|
||||||
|
|
||||||
<figure><img src="https://gitbookio.github.io/onboarding-template-images/markdown-hero.png" alt=""><figcaption></figcaption></figure>
|
|
||||||
|
|
||||||
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 %}
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
icon: network-wired
|
|
||||||
---
|
|
||||||
|
|
||||||
# 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 %}
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
---
|
|
||||||
icon: globe-pointer
|
|
||||||
---
|
|
||||||
|
|
||||||
# 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.
|
|
||||||
|
|
||||||
<figure><img src="https://gitbookio.github.io/onboarding-template-images/publish-hero.png" alt=""><figcaption></figcaption></figure>
|
|
||||||
|
|
||||||
@ -1,23 +0,0 @@
|
|||||||
---
|
|
||||||
icon: bullseye-arrow
|
|
||||||
---
|
|
||||||
|
|
||||||
# Quickstart
|
|
||||||
|
|
||||||
<figure><img src="https://gitbookio.github.io/onboarding-template-images/quickstart-hero.png" alt=""><figcaption></figcaption></figure>
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
<div data-full-width="false"><figure><img src="https://gitbookio.github.io/onboarding-template-images/quickstart-import.png" alt=""><figcaption></figcaption></figure></div>
|
|
||||||
|
|
||||||
### 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.
|
|
||||||
Loading…
Reference in New Issue
Block a user