About
The about page is generated from a about.yml
file found in the data
folder of af-election-api.
Properties
sections<Array[Object]>
- Sections of the about page. Each entry on the sections array will result in a groupid<String>
- Id of the section. Must be unique and will be used in the page urlname<String>
- Human readable name of the group to be displayed on the sidebarchildren<Array[Object]>
- List of pages in this groupid<String>
- Id of the page. Must be unique and will be used in the page urlname<String>
- Human readable name of the page to be displayed on the sidebarcontent<String>
- Content of the page. Markdown is supported
On the application, each page will have a unique url with the following format about/:sectionId/pageId
.
Example
sections:
-
id: about
name: About
children:
-
id: about-ndi
name: About NDI
content: |
# Commodo incididunt fugiat aute magna ex
Lorem markdownum sine **instantes saepe** adsumit confiteor novavit...
-
id: background
name: Background
content: |
This is the content
-
id: 2018
name: 2018 Wolesi Jirga
children:
-
id: det
name: Details
content: |
These are the details of this election
-
id: data-sources
name: Data Sources
content: |
This is the content
Api
The about page endpoint is generated at the same time as the global configuration using the CLI command:
$ yarn api config global
/about.json
[
{
"id": "about",
"name": "About",
"children": [
{
"id": "about-ndi",
"name": "About NDI",
"content": "This is the content. **Markdown supported**"
},
{
"id": "background",
"name": "Background",
"content": "This is the content. **Markdown supported**"
}
]
},
"..."
]