Style Guide
A style guide to reference and copy blocks from when writing an article for the TSG Forge Wiki.
Last updated
A style guide to reference and copy blocks from when writing an article for the TSG Forge Wiki.
Last updated
Use this style guide to browse the most common "blocks" available in the GitBook documentation suite to get a good overview of what is possible to include in an article to convey information to the reader.
The raw markdown text formatting of this page can be found at https://raw.githubusercontent.com/The-Scripters-Guild/ForgeWiki/main/community/contributing-to-tsg-forge-wiki/style-guide.md
There are different ways of formatting text that can be useful in wiki articles. The example below will show these along with how to make different lists.
Bold
Italic
Code
Strikethrough
External link: This is a link
Internal link: This is another link
By clicking the # on the right of the heading above, the page URL will get the anchor ID of that heading attached to it. This can be used to link readers straight to a specific section of the article.
Usually these anchor ID names are auto-generated by GitBook as a heading is made, but this heading has a custom anchor ID named "cat".
Keyboard:
Controller:
It is encouraged to use images to help explain a topic in a wiki article. Please try to compress the image size before uploading it to make pages load up faster. A resolution of 1280x720 px or lower and the .jpg extension are recommended. Try to keep image file size under 300 KB per image.
Resize your webpage to see how the images below interact on different page widths.
Here are some ways to format single images placed in an article:
Fit – Removes all size specifications and displays either at full size or capped at a maximum width of 735 pixels for larger images.
Full-width – Spans the full width of the window. Not ideal in most cases as it breaks the shape continuity of the article.
Large – 75% of the image size
Medium – 50% of the image size
Small – 25% of the image size
Just two two-image groups on top of each other.
GitBook has four different visually appealing infobox designs that can be used to catch the reader's attention. Add these into the article when there is something important that the reader should pay attention to even if they are just skimming the article.
Info, great for showing general information, or providing tips and tricks.
Warning, good for showing important information or non-critical warnings.
Danger, good for highlighting destructive actions or raising attention to critical information.
Success, good for showing positive actions or achievements.
Infoboxes can also contain images, if that is desired:
Here is an image of a cat that you should pay attention to.
Here are two dangerous cats side by side!
Keep information organized and make documenting data easier by adding a table to your page.
Info left 1
Info center 1
Info right 1
Info left 2
Info center 2
Info right 2
Info left 1
Info center 1
Info right 1
Info left 2
Info center 2
Info right 2
Cards can be used to display information in neat blocks. GitBook card groups are based on the <table> tag in HTML.
Expandable sections can be used to keep pages shorter, hide longer content, or create FAQs
Tabs can be used to display large blocks of related information without creating a long, hard-to-navigate page.
Here are some things only visible in the first tab.
Embeds are a useful tool to show external content directly in the page.
In the case of embeds that don't link to the source page, be sure to include the link to them afterwards, if it's beneficial for the reader.
Okom
Letters:
Numbers:
Modifier Keys:
Large Keys:
Signs:
Function Keys:
Numpad:
Mouse:
Buttons:
Triggers and Bumpers:
Dpad:
Left Stick:
Right Stick:
Both Sticks:
Menu Buttons:
And here we have three small cats who are the same size as the text:
A cool image with text on the other side of the image continuing underneath the image if nothing is done to format it.
Small inline image of a cat.
Nothing to see here, except this small cat
This card will link you to the "Welcome" page on click
Click this card
to find out the basics
about Halo Infinite's Forge!
Here is a separate LARGE card group
that can have text
on multiple lines
A card with a cat image. Here you can write more info about this if needed.
