Skip to content

Latest commit

 

History

History
83 lines (66 loc) · 4.26 KB

README.md

File metadata and controls

83 lines (66 loc) · 4.26 KB
Raw

Sanny Builder Help

Release Discord

Based on the original that brings the help.chm, GitBook and my own doc-chm. This is the first offline version of docs.sannybuilder.com, worked together, to understand much of the GitBook site Markdown and highlight SB3 code easy and quickly.

image

Table of content

Install

Just download the chm corresponding to your language:

language file state
English help [##########] ⭐ complete
Español help3082 [#########.] ⌛ in process
Pусский help1049 [########..] ⌛ in process
Türkçe help1055 [##........] ⌛ in process

And optionally, move the file to directory.

<sanny builder foldes>/help/<here>

to be able to open it from sanny builder, or directly, opening it as if it were a common windows executable.

BUGS:

Blank views?
If when you open the file, it does not load the content. Only by unchecking the Windows security box when opening the file, you could have solved the problem.
No images?
Make sure you have the files folder in <sanny>/help/. This is where many of the images in the documentation are stored, to speed up the loading of the pages and the opening of CHM.
Syntax Error?
If it appears when you run CHM, it is because you do not have the latest version of IE (Internet Explorer) installed. Exactly v. 11.
If it appears when entering any page, report it here with a screenshot so we can bring it corrected in the next days.

Collaborations

The world is very welcome to collaborate in what you want with the documentation.
Providing information, bug reports or optimizing the main script, which brings Markdown to life.

Creating pages

After create a fork (cloning or downloading) of the repository. Just go to the folder that contains the section you want to collaborate on.
For example to help-system/<lang>/scm-documentation/sa/ and create any file with the extension .HTML with the following inside.

<!DOCTYPE html>
<html>
<head>
  <title>Example Page</title>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <link rel="stylesheet" type="text/css" href="../../../style/style.css">
</head>
<body>

This is a template

<script src="../../../js/main.min.js"></script>

From here, just define the title that the page will display, at the <title> tags and replace This is a template with whatever content you want. You can use HTML or Markdown, which the engine we use here already has the ability to work with tables, lists, stylized text (bold, italic, strikethrough, highlighted, underlined, inserts), links, images, citations, spans and divs.

You can see an example of how to generate certain things quickly, by going into a test file test/markdown/html.html.

After, create your pull request and ready.

Reporting issues

Just create a ticket and describe in detail.

Thanks

Contributor by
Seemann
(x87)		 v0.1 - v1.3 : Critics and error reports from early stages
v1.8 : Fix Version History at 0.7
v1.12 - 1.13 : Give the idea of a light color theme and how to improve it
Yushae Raza
(darksavage)		 v1.4 : Aggrege to SA the Vehicle ID List
v1.6 : fix weapons GXT

Compiling CHM files

Use HTML Help Workshop v4.