Skip to content

iexcloud/docs

Repository files navigation

IEX Cloud Apperate Documentation

The Apperate documentation is published to https://iexcloud.io/documentation/.

We write Markdown files that use an expansion syntax called MyST (Markedly Structured Text). Here are some helpful Markdown MyST articles.

  • CommonMark basic syntax.
  • Articles that contain additional examples that include extensions we use via the Euro theme. Important: Selet the Markdown (MyST) tabs when you view the examples.

All of the articles are nested in the source/ folder. The article/section hierarchy follows the source/ folder's nested hierarchy of Markdown files (.md) and folders. The Markdown files, starting with source/index.md specify the hierarchy via MyST style {toc} directives.

Here is a representative sampling of repository files:

File Description
source/administration/access-and-security.md Article called Access and Security.
source/administration/access-and-security/ Folder contains the above article’s image files.
source/load-data.md A section intro article (i.e., parent article) called Load Data. Its {toc} tree at the article top lists child articles.
source/load-data/ Folder…
- Contains the parent article’s image files
- Contains the child articles and their image file folders

Related Topics

Build instructions