https://github.com/cloudboost/developers
Developer documentation for CloudBoost
https://github.com/cloudboost/developers
Last synced: 10 months ago
JSON representation
Developer documentation for CloudBoost
- Host: GitHub
- URL: https://github.com/cloudboost/developers
- Owner: CloudBoost
- Created: 2015-08-24T10:14:20.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-05-20T04:52:59.000Z (about 8 years ago)
- Last Synced: 2025-04-13T17:13:53.772Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://developers.cloudboost.io
- Size: 12.3 MB
- Stars: 6
- Watchers: 13
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tutorial
[](https://travis-ci.org/CloudBoost/tutorial)
Tutorials for CloudBoost is hosted at [https://tutorials.cloudboost.io](https://tutorials.cloudboost.io)
# Guide for writing tutorials
Apart from Markdown [Guide for markdown](https://guides.github.com/features/mastering-markdown), this guide will help you to make tutorials compatible with [https://tutorials.cloudboost.io](https://tutorials.cloudboost.io)
## Menu Headings
Menu headings should start with #(h1 tag), **without full stop(.)** at the end.
## Info
Info quotes should enclosed in span tags with class="tut-info".
eg: ```Info```
## Important quotes
Important quotes should be enclosed in span tags with class="tut-imp".
eg: ```important ```
## Warning quotes
Warning quotes should be enclosed in span tags with class="tut-warning".
eg: ```Warning ```
## Images
For full length images, use image tag with class="full-length-img".
eg: ```
```
For center/mid length images, use image tag with class="center-img".
eg: ``````
## Small / One line code snippets
Small code or one line code snippets should be enclosed in span tags with class="tut-snippet".
eg: ```var x=150; ```
## Multi line code snippets
Multi lines code snippet acts as code tabs of different programming languages. These multi line code should be written in span tags with class="(name of programming language)-lines" and with data attribute data-query="(functionality name of this code)". The main code should enclosed in ```(original markdown for code snippet) inside of span tags.
eg:
```
`` `
your code line 1
your code line 2
your code line 3
` ``
```
You can add more programming languages codes followed one after one of same functionality.
eg:
```
;
;
```
**Important**
* There shoud not be any space between codes line, if it necessary to display space, use // quote marks
eg:
```
` ``
var i=0;
//
var j=2
`` `
```
* There should be one line space between different programming language span tags.
* data-query="functionality name" should be same for different programming language of same functionality.
* Functionality name should be unique and shoudn't conflict with other functionality names.
* Following are the allowed strings to mention the programming language
* Javascript->js-lines
* .Net->dotnet-lines
* Java->java-lines
* Nodejs->nodejs-lines
* IOS->ios-lines
* IOT->iot-lines
* Ruby->ruby-lines
* cURL->curl-lines
* XML->xml-lines
# Contribute
If you want to contribute to this repo. Please make sure you spell check everything and make sure you have tested the code with the live CloudBoost API before sending us the pull request.