Данный ресурс использует генератор статических сайтов HUGO c темой docuapi (стандартные шаблоны содержат индивидуальные изменения).
Содержание папки content выводится единой страницей на сайте.
Заголовки h1 отображается на странице сайта как меню разделов (левая часть сайта).
Заголовки h2 отображается на странице сайта как подразделы меню (левая часть сайта).
Прочие заголовки обрабатываются в штатном режиме.
Управлять порядком вывода данных, содержащихся в нескольких файлах, можно при помощи параметра weight, который задается в начале каждого файла. Чем ниже значение параметра weight, тем выше будет приоритет выводимой информации.
Пример:
---
weight: 5
---
## **get_block_count**
```shell
$ curl -X POST http://127.0.0.1:18081/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_block_count"}' -H 'Content-Type: application/json'
```
```json
{
"id": "0",
"jsonrpc": "2.0",
"result": {
"count": 993163,
"status": "OK"
}
}
```
Look up how many blocks are in the longest chain known to the node.
Alias: **getblockcount**.
| | Parameter | Type | Description
| --- | --- | --- | ---
|**Inputs:** | *None* | |
|**Outputs:** | count | unsigned int | Number of blocks in longest chain seen by the node.
| | status | string | General RPC error code. "OK" means everything looks good.
## **get_block_count** - Название метода. Указывается в качестве заголовка h2.
```shell - Описание примера вызова. Этот раздел будет размещён в правой секции, напротив соответствующего метода (в соответствующей вкладке).
Затем следует описание метода. Входные и выходные параметры оформляются в виде таблицы.
Для добавления нового языка необходимо создать для него отдельную вкладку.
Для этого отредактируйте соответствующий файл config.toml.
Например, чтобы добавить пример вызова на языке Python, необходимо добавить секцию:
[[params.language_tabs]]
key = "python"
name = "Python"
key - отметка, по которой все примеры в разрезе языка Python будут собраны на одну вкладку. Необходимо использовать названия языков программирования полностью, не прибегая к сокращениям (в данном случае будет работать штатная подсветка для синтаксиса).
name - название соответствующей вкладки.
После этого для желаемого метода необходимо добавить пример работы с API.
Пример:
```python
API example
`` `
*Описание следует добавлять до начала описания самого метода (shell) и его параметров (json).
Данный сайт поддерживает работу на нескольких языках.
Для этого необходимо подготовить перевод файла wallet_rpc.**.md и указать вместо ** в имени нового файла с переводом, соответствующий код языка для перевода.
Пример:
wallet_rpc.en.md - вариант для английского языка.
wallet_rpc.ru.md - вариант для русского языка.
Добавление языкового пункта в меню сайта делается путем редактирования файла config.toml
[languages.ru]
languageName = "Русский"
weight = 1
title = "Monero RPC API"