Git Product home page Git Product logo

documentation's Introduction

documentation

Structure

  • Path for pictures: src/Images/. Each picture should be stored in a folder with the same name as the documentation section.
  • Path for MD files: src/md/src/. Each section is located in the folder of the same name. In the section there is a main file (index.md) and files of subsections.

Note The first level header can only be contained in the main file(index.md) in a single instance. Subsections files can have headers of the second and higher level.

Guide

Block image

To display the picture, use the following syntax:

[ ![ImageName](thumbImagePatch) ](imageOrYoutubePath)
  • ImageName - the name of the image that will be displayed if there are errors during the download.

  • thumbImagePath - the address of the picture that will be displayed when the documentation is displayed. There should be certain sizes of 1000x768. For example: 'Images/userGuide/manageLaunches/MergeScheme.png'

  • imageOrYoutubePath - the name of the image or link to youtube which will be shown when clicking on the picture. For example 'Images/userGuide/manageLaunches/MergeScheme.png' or 'https://youtu.be/7PZIowd9III'

Block note

To display the block 'Note', use the following syntax:

>**Note:**
yout note text

documentation's People

Contributors

ailjushkin avatar alehb avatar alejandrokolio avatar ampc avatar artsiomyeliseyenka avatar avarabyeu avatar avishaymahluf avatar dkorobtsov avatar e-olga avatar evjlobanova avatar fbernath avatar georgeouspro avatar gordiievskyi avatar ifatsharifi avatar jevgenid avatar kanstantsinsudzilouski avatar ksuglotova avatar nvborisenko avatar pbortnik avatar rpgithubtestuser avatar siarheidubovik avatar slowpokex avatar svetasaraeva avatar tareqalayan avatar tatianamikhailova11 avatar viktorkondin avatar yana95 avatar zarkonan avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.