Skip to content
Inside Splynx documentation
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
files
images
.gitignore
LICENSE
README.md

README.md

Splynx site documentation

In this repository store documentation files for Splynx site. After pushing to this repository, documentation in Splynx site will be automatically updated.

Files format description

Translations

Languages files should be placed in self directories.

Language files example

Page title

Each page should be begin from the page title.

Page Title
==========

This title will be show in the header of the documentation panel.

Page title example

Image

![Image alt](http://site.com/images/img.png)

Image with size

For set image size you can use url parameters.

![Image alt](http://site.com/images/img.png?w=200&h=100)

This code will be converted to:

<img src="http://site.com/images/img.png?w=200&h=100" alt="Image alt" width="200" height="100">

Image src

For images src you can use absolute url or relative path.

Absolute url:

http://images.google.com/some_image.png

Relative path (recommended):

./images/my_image.png

Icon

<icon class="image-icon">![Image alt](image.png)</icon>

Links

You can use:

  • Absolute links. This links will be open in new tab.
[Google](https://google.com)
  • Relative links to other docs pages.
[Invoices](finance/invoices/invoices.md)
  • Javascript functions
// Switch Splynx page
[Open config](javascript:switch_page('/admin/config'))

// Open dialog
[Add location](javascript:open_dialog_new('administration/locations--add'))

// Open help dialog
[Please help me](javascript:open_help_dialog('index.md'))

Youtube video

<iframe frameborder=0 height=270 width=350 allowfullscreen src="https://www.youtube.com/embed/wQyBkJDsmuw?wmode=opaque">Video on youtube</iframe>
You can’t perform that action at this time.