Описание

Данный ресурс использует генератор статических сайтов HUGO c темой docuapi (стандартные шаблоны содержат индивидуальные изменения).

Содержание папки content выводится единой страницей на сайте.

Форматирование

Заголовки h1 отображается на странице сайта как меню разделов (левая часть сайта).
Заголовки h2 отображается на странице сайта как подразделы меню (левая часть сайта).
Прочие заголовки обрабатываются в штатном режиме.

Управлять порядком вывода данных, содержащихся в нескольких файлах, можно при помощи параметра weight, который задается в начале каждого файла. Чем ниже значение параметра weight, тем выше будет приоритет выводимой информации. Для одного уровня заголовков weight может быть одинаков, например если в файле только заголовки h2 то во всех фалах может быть использован одинаковый weight, но если встретится файл с заголовком h1 и таким же weight, то возникнет ошибка.

Пример:

---
weight: 205
---

Каждый метод описан в отдельном файле. Методы разнесены по папкам daemon и wallet.

Пример оформления описания метода:

    ---
    weight: 805
    ---

    ## **store**

    ```shell
      curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"store"}' -H 'Content-Type: application/json'
    ```
    ```python
      ...^ see introduction
      data = {
          "jsonrpc": "2.0",
          "id": "0",
          "method": "store"
      }
      ...^ see introduction
    ```
    ```py
      ...^ see introduction
      rpc_connection.store()
    ```
    ```json
      {
        "id": "0",
        "jsonrpc": "2.0",
        "result": {
        }
      }
    ```
    Save the wallet file.  
    Alias: *None*.  

    |             | Parameter | Type | Description
    | ---         | ---       | ---  | ---
    |**Inputs:**  | *None*.   |      |
    |**Outputs:** | *None*.   |      |

## **store** - Название метода. Указывается в качестве заголовка h2.
```shell и подобные - Описание примера вызова. Этот раздел будет размещён в правой секции, напротив соответствующего метода (в соответствующей вкладке).
Затем следует описание метода. Входные и выходные параметры оформляются в виде таблицы.

Добавление собственных примеров работы с api на других языкаx \ библиотеках.

Для добавления нового языка необходимо создать для него отдельную вкладку.
Для этого отредактируйте соответствующий файл config.toml.
Например, чтобы добавить пример вызова на языке Python, необходимо добавить секцию:

[[params.language_tabs]]
key = "python"
name = "Python"

key - отметка, по которой все примеры в разрезе языка Python будут собраны на одну вкладку. Необходимо использовать названия языков программирования полностью, не прибегая к сокращениям (в данном случае будет работать штатная подсветка для синтаксиса). name - название соответствующей вкладки.

После этого для желаемого метода необходимо добавить пример работы с API.

Пример:

  ```python
    API example
  `` `

*Описание следует добавлять до начала описания самого метода (shell) и его параметров (json).

Поддержка мультиязычности

Данный сайт поддерживает работу на нескольких языках.
Для этого необходимо подготовить перевод файла some_method.md и поместить его в папку для вашего языка, например content/ru/wallet/store.md.

Пример: content/en/wallet/store.md - вариант для английского языка. content/ru/wallet/store.md - вариант для русского языка.

Добавление языкового пункта в меню сайта делается путем редактирования файла config.toml. Задается имя для языка и путь к файлам с переводом.

[languages.ru]  
languageName = "Русский"  
weight = 1  
contentDir = "content/ru"  
title = "Monero RPC API"