-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e4803b6
commit 274199a
Showing
10 changed files
with
120 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Get Started | ||
|
||
## Try it out | ||
|
||
Use this area to play with the editor and get to grips with some of the content blocks. Have a play then move on to the next page! | ||
|
||
|
||
|
||
## Moving on | ||
|
||
All good? Let's explore some of the main GitBook concepts, starting with **Spaces**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Table of contents | ||
|
||
* [Get Started](README.md) | ||
|
||
## The Basics | ||
|
||
* [Spaces](the-basics/spaces.md) | ||
* [Collections](the-basics/collections.md) | ||
* [The GitBook editor](the-basics/the-gitbook-editor.md) | ||
* [Live edit and locked edits](the-basics/live-edit-and-locked-edits.md) | ||
* [Change requests](the-basics/change-requests.md) | ||
|
||
## Publishing | ||
|
||
* [Publishing your content](publishing/publishing-your-content.md) | ||
|
||
## Tips and tricks | ||
|
||
* [Speed up with quick find](tips-and-tricks/speed-up-with-quick-find.md) | ||
|
||
## Next steps | ||
|
||
* [What next?](next-steps/what-next.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# What next? | ||
|
||
## Over to you! | ||
|
||
There are tonnes more features in GitBook – and don't worry, you'll discover the ones important to you over time. For now, why not **invite your team**, **create a space of your own**, or get organised off the bat and **plan your collections**? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Publishing your content | ||
|
||
GitBook makes publishing lovely docs a breeze. Hit the ‘Share’ button up top, select ‘Publish’, configure a few settings and you're good to go! | ||
|
||
There are a bunch of options for publishing – not everything has to go straight to the entire world. If you need to know more about the different types of publishing, you can check out detailed documentation over at the Publishing section of the GitBook docs. | ||
|
||
{% embed url="https://docs.gitbook.com/spaces/space-visibility" %} | ||
|
||
{% hint style="info" %} | ||
**Good to know!** We're still documenting this version of GitBook. Some documentation links might be out of date for now! | ||
{% endhint %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Change requests | ||
|
||
## Welcome to branched content… | ||
|
||
Change requests let you create branched content – allowing you to make edits away from your main content branch. The idea is: you create a branch of your main content, make changes to that branch, submit it when you're ready, then you or someone else merges those changes into the main content. | ||
|
||
If you've ever used a Git-based workflow, this should feel pretty natural. If not, no worries! You can try creating a change request now. First, if you haven't already, lock this space for live edits. | ||
|
||
You'll see an Edit button up top, give it a tap, and you'll be in change request mode! From here, you can make changes without worrying about messing up the main content branch. | ||
|
||
When you're ready, Submit the edits, then Merge them using the buttons on the bottom bar, and you'll see your changes reflected in the content! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Collections | ||
|
||
## A place to group your spaces | ||
|
||
A collection in GitBook is kind of like a folder for your spaces or other collections. When you create a collection, you'll get a kind of ‘tree’ view in your sidebar. | ||
|
||
This makes it super easy to collect all your content into logical groups and can have a big impact on your GitBook experience! | ||
|
||
## Going further with collections | ||
|
||
We're just touching on the basics here, but if you want to get extra fancy, collections can actually be published and have their very own set of permissions! Feel free to go explore, but for now, let's have a peek at the GitBook editor. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Live edit and locked edits | ||
|
||
## Live edit | ||
|
||
You might have noticed that you can pretty much edit anything in this space. This is because the space is in what's know as **live edit** mode. In this mode, anyone who has permission can edit the content directly. This is great for early-days use. It is great for quick changes. No need for complex workflows. | ||
|
||
At some point, you may reach a greater level of maturity with your content. That's when you may need some of the more powerful workflow features in GitBook… | ||
|
||
## Locked edits | ||
|
||
The alternative to a live edit mode is called **locked edits**. Spaces that are locked for live edits aren't directly editable, and any edits you need to make must be handled through **change requests**. You can lock a space using the space menu and selecting 'Lock live edits'. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Spaces | ||
|
||
## A space to create | ||
|
||
Almost everything in GitBook revolves around a **space**. What you're looking at right now is a space (well, technically, it's some words inside a content block inside a page inside a space, but let's not get too fancy) and it's basically a collection of pages. | ||
|
||
Folks use spaces for all kinds of things. You might want to create API documentation, a design system, a place to document calls and meetings. Whatever it might be, chances are, you'll be using spaces a bunch in GitBook. | ||
|
||
## Publishing and sharing | ||
|
||
Spaces can be published to the whole world, or just some of it, or just to a few very specific people. You can also invite folks to collaborate with you on a space if you're on a community, team, or business plan. | ||
|
||
There's tonnes you can do with Spaces, and you'll definitely figure them out over time, but for now, let's move on to **collections…** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# The GitBook editor | ||
|
||
Everything you've read so far has been in the **editor**. This window right here is where all your page content comes together. | ||
|
||
## Block-based | ||
|
||
The Editor is full of all sorts of content blocks, like this hint: | ||
|
||
{% hint style="info" %} | ||
**Check me out!** I’m an editable 'hint' block, and I think I look pretty great 💅 | ||
{% endhint %} | ||
|
||
You can access the block list at any time by hitting `CMD + /` (`CTRL + /` on Windows) to bring up a filterable list of blocks. Or you can check out our documentation for a full list of blocks with examples. | ||
|
||
## A note on markdown | ||
|
||
While the editor supports most common Markdown decorators, behind the scenes, GitBook is converting this to a document format that works with our block-based editor. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Speed up with quick find | ||
|
||
If you haven't already, give that `CMD + K` (`CTRL + K` on Windows) shortcut a little tap. | ||
|
||
Cool, right? This is our quick find palette, and it's super useful if you need to jump between content quickly. | ||
|
||
If this is your first time using GitBook, you probably don't have a whole bunch of content right now. Once you start filling it with spaces and collections and all the wonderful content you're creating, you're gonna need a quick way to navigate through it all. Quick find will let you search for spaces, pages and content within pages; and navigate directly to them with a few keypresses. Get used to that shortcut! |