Documentation

Custom Components

Throughout the docs, you'll notice that we make use of custom components, in addition to the default markdown, to render special elements. An overview of these can be found below:

Rendering a Public REST API Tester

<livewire:endpoint spec="api/public-rest-api/endpoints/specs/blockchain.json" />

Rendering a Page Reference

<livewire:page-reference page="/docs/delegate-registration" />

Rendering an Embed Link

<livewire:embed-link url="https://blog.ark.io/ark-core-series-schnorrs-multisignatures-4979caac887a" caption="ARK Core - Schnorr" />

Rendering a Sidebar Group

<x-general.sidebar-group path="/docs/api/public-rest-api/*" title="Public REST API">
    <x-general.sidebar-link path="/docs/api/public-rest-api/getting-started" name="Getting Started" />
</x-general.sidebar-group>

Rendering a Sidebar Link

<x-general.sidebar-link path="/docs/api/public-rest-api/getting-started" name="Getting Started" />

Rendering a Sidebar Link with Children

The root path property should represent the closest parent of the child paths.

<x-general.sidebar-link
    path="/docs/api/public-rest-api/endpoints"
    name="Endpoints"
    :children="[
        ['path' => '/docs/api/public-rest-api/endpoints/blockchain', 'name' => 'Blockchain'],
        ['path' => '/docs/api/public-rest-api/endpoints/blocks', 'name' => 'Blocks'],
        ['path' => '/docs/api/public-rest-api/endpoints/delegates', 'name' => 'Delegates'],
        ['path' => '/docs/api/public-rest-api/endpoints/node', 'name' => 'Node'],
        ['path' => '/docs/api/public-rest-api/endpoints/peers', 'name' => 'Peers'],
        ['path' => '/docs/api/public-rest-api/endpoints/transactions', 'name' => 'Transactions'],
        ['path' => '/docs/api/public-rest-api/endpoints/votes', 'name' => 'Votes'],
        ['path' => '/docs/api/public-rest-api/endpoints/wallets', 'name' => 'Wallets'],
    ]"
/>

Rendering an Alert

Type can be hint, info, success, warning or error. Title can be any string, which will replace the default title based on alert type.

<x-alert type="info" title="Custom Alert Title">
Hello World!
</x-alert>

Rendering a Link Collection

<x-ark-link-collection
    :links="[
        ['path' => '/docs/core/overview/services/attributes', 'name' => 'Attributes'],
        ['path' => '/docs/core/overview/services/cache', 'name' => 'Cache'],
        ['path' => '/docs/core/overview/services/events', 'name' => 'Events'],
        ['path' => '/docs/core/overview/services/filesystem', 'name' => 'Filesystem'],
        ['path' => '/docs/core/overview/services/logging', 'name' => 'Logging'],
        ['path' => '/docs/core/overview/services/mixins', 'name' => 'Mixins'],
        ['path' => '/docs/core/overview/services/pipeline', 'name' => 'Pipeline'],
        ['path' => '/docs/core/overview/services/queue', 'name' => 'Queue'],
        ['path' => '/docs/core/overview/services/schedule', 'name' => 'Schedule'],
        ['path' => '/docs/core/overview/services/triggers', 'name' => 'Triggers'],
        ['path' => '/docs/core/overview/services/validation', 'name' => 'Validation'],
    ]"
/>

Rendering a Separator

Type can be bold, dotted, dashed or line (default). Spacing can be a number between 1 and 8 (default)

<x-ark-separator />

<x-ark-separator type="dashed" />

<-x-ark-separator type="dotted" spacing=5 />

Tutorial Intro Page

The tutorial intro page has specific properties you can use at the top of the document as explained below (they need to be encapsulated between the listed ---)

---
title: <text>
excerpt: <text>
excerpt_long: <text>
is_featured: <true/false>
learn_about: <text>
learn_topics:
- <list of topics>
assets: <path to assets directory>
---

Please note that the assets directory expects to hold 3 images called featured.svg, banner.svg and image.svg as these are used on the various tutorial pages.

Documentation Pages

Documentation pages have a title property that is used for example used for the navigation at the bottom of the pages.

---
title: <text>
---

Security

If you discover a security vulnerability within this package, please send an e-mail to [email protected]. All security vulnerabilities will be promptly addressed.

Credits

This project exists thanks to all the people who contribute.

License

MIT © ARK Ecosystem