isabella232 / gatsby-theme-parliament

A Gatsby Theme for building markdown powered Adobe I/O sites.

Gatsby Theme Parliament

A Gatsby Theme for building markdown powered Adobe I/O sites.

Why Gatsby ?

For many reasons :

• Static site
• Single Page Application
• React Server Side Rendered at build time
• Blazing fast
• Large and active community
• Huge ecosystem of plugins
• Open source

and more ... see https://www.gatsbyjs.com/why-gatsby/.

Why Gatsby theme ?

Gatsby themes allow Gatsby site functionality to be packaged as a standalone product for others to easily reuse. Using a theme, all of your default configuration lives in an npm package.

View the Gatsby site templates using Gatsby Theme Parliament:

Documentation template

• Demo
• Repository

Platform template

• Demo
• Repository

Product template

• Demo
• Repository

Contents

• Getting started
• Content structure
• Configuration
• Building
• Publishing
• Upgrading the theme
• Writing Enhanced Markdown
• Embedding markdown documents and filtering content
• Customizations
• Issue tracker
• Contributing

Getting started

This section will help you get started building a Gatsby site with Gatsby Theme Parliament.

Pre-requisites

• Install Node.js LTS
• Install a package manager like npm or yarn

Using GitHub repository templates

To initialize a site repository, you can use one of the available Gatsby site templates mentioned above. Simply click on the “Use this template” button to create a new GitHub repository of the template.

The templates are pre-configured with example pages.

Using the Adobe I/O CLI

First install the Adobe I/O CLI via the Terminal

npm install -g @adobe/aio-cli

Then install the Doc Plugin by running.

aio discover -i

Select the @adobe/aio-cli-plugin-doc plugin by pressing the Spacebar and finally press Enter to install it.

For more information about the Doc plugin, see https://github.com/adobe/aio-cli-plugin-doc.

Now you can create your site by running

aio doc init path/to/site/folder

which will use by default the Documentation site template.

You can specify another template with

aio doc init path/to/doc/folder --template URL_TO_TEMPLATE_GIT_REPO

Content structure

The content of the site is written in Markdown which is both easy to read and easy to learn.

As in most cases, the markdown content is stored in GitHub, we support GitHub Flavored Markdown (GFM), which provides additional functionality for common formatting needs. Additionally, Adobe extended Markdown in a few ways to support certain features see Enhanced Markdown.

Make sure the markdown content is located under src/pages and please follow below guidelines for writing content.

Use a folder structure to define your site pages e.g. :

root
├- src/pages [/]
│  ├- index.md 
│  ├- hero.png
│  ├- api [/api/]
│  │  └- index.md   
│  └- guides [/guides/]
│      ├─ index.md 
│      └- get_started [/guides/get_started/]
│        ├- index.md
│        └- debugging [/guides/get_started/debugging/]
│           └- index.md
├- .env
├─ gatsby-config.js
└─ package.json 

Folder names should be unique.

Internal links

Use relative links between markdown pages e.g. with the example folder structure you can add a link from /guides/index.md to /api/index.md with:

[Link to API](../api/) 

Configuration

To make sure you don't run into troubles during the site build process, please follow the below configuration steps.

.env file

Follow these steps to configure your .env file.

1. Copy .env.example to .env
2. Add the appropriate values in the .env file

The .env should not be committed.

GitHub's API is being called during the site build phase to retrieve the authors of every markdown page under src/pages. If the GitHub Token information is missing, the build will just print a warning, and no contributor information will be retrieved (just the contributor information in a page's front matter, if any, will be used).

To retrieve your GitHub personal access token, you can follow these steps. Only READ permissions on repositories are required for the token.

.env settings for GitHub Contributors

For example, if your doc site repo was at https://github.com/adobe/gatsby-theme-parliament using the main branch, this would be what your .env would look like:

REPO_GITHUB_TOKEN=YOUR_PERSONAL_ACCESS_TOKEN_HERE
REPO_OWNER=adobe
REPO_NAME=gatsby-theme-parliament
REPO_BRANCH=main
REPO_ROOT=example

By default, you can omit the ROOT env var, and it should use the root folder as the source of the documentation pages. If your site is in a sub-folder, add the relative path as the ROOT.

.env settings for the Feedback Component and Analytics

• You need to set up Adobe Launch, with an Adobe Analytics Reporting Suite
• In Adobe Analytics, add a custom eVar (Text String type) to capture the feedback. This eVar will contain either "yes" or "no".
• In Adobe Launch, create two Data Elements:
  1. Feedback-Yes: edit the code and paste in return document.querySelectorAll('button.feedback-yes')[0].innerText
  2. Feedback-No: edit the code and paste in return document.querySelectorAll('button.feedback-no')[0].innerText
• In Adobe Launch, for the two Data Elements, make sure these checkboxes are checked:
  1. Enable Default Value
  2. Force lowercase value
  3. Clean text
• In Adobe Launch, create three Rules:
  1. Feedback-Yes: On click, it will set variables in Adobe Analytics (set the custom eVar to value of the Feedback-Yes Data Element), and then Send the Beacon
  2. Feedback-No: On click, it will set variables in Adobe Analytics (set the custom eVar to the value of the Feedback-No Data Element), and then Send the Beacon
  3. Analytics: On library loaded (page top), Send the Beacon
• In Adobe Launch:
  1. Go through the Publishing Flow, don't forget to Add All Resources
  2. In Environments, select the appropriate environment, and under the Install column, select the icon
  3. Copy the url displayed in the script tag

This last value will be the value you put in GATSBY_LAUNCH_SRC. GATSBY_LAUNCH_SRC_INCLUDE_IN_DEVELOPMENT is a boolean value, set to true if you want to enable the script to run in development.

Example:

GATSBY_LAUNCH_SRC=https://your.adobe.launch.url.here
GATSBY_LAUNCH_SRC_INCLUDE_IN_DEVELOPMENT=true

Global Navigation

The Global navigation links are configurable in gatsby-config.js under pages. If you follow the recommended content structure, you can define the path value using the folder names.

For example, the following folder structure maps to the URL defined in brackets:

src/pages [/]
├- index.md 
├- api [/api/]
│  └- index.md   
└- guides [/guides/]
   └─ index.md 

then define your Global Navigation using pages in gatsby-config.js:

pages: [
  {
    title: 'Adobe Analytics',
    path: '/'
  },
  {
    title: 'Guides',
    path: '/guides/'
  },
  {
    title: 'API Reference',
    path: '/api/'
  }
]

The order in which the pages are defined is respected in the Global Navigation.

Side Navigation

The Side navigation links are configurable in gatsby-config.js under subPages. You have to create a directory hierarchy which will be represented literally in the URL so that any sub page path starts with a path from pages.

For example, the following folder structure maps to the URL defined in brackets:

src/pages [/]
├- index.md 
├- api [/api/]
│  └- index.md   
└- guides [/guides/]
   ├─ index.md 
   └- get_started [/guides/get_started/]
      ├- index.md
      └- debugging [/guides/get_started/debugging/]
         └- index.md

then define your Side Navigation for /guides/ using subPages in gatsby-config.js:

pages: [
  {
    title: 'Adobe Analytics',
    path: '/'
  },
  {
    title: 'Guides',
    path: '/guides/'
  },
  {
    title: 'API Reference',
    path: '/api/'
  }
],
subPages: [
  {
    title: 'Get Started',
    path: '/guides/get_started',
    pages: [
      {
        title: 'Debugging',
        path: '/guides/get_started/debugging/'
      }
    ]
  }
]

Notice that all sub pages paths have to be children of the top-level navigation path.

If you don't want to associate a location with a top-level navigation item, you have to reuse the same top page path for a sub page e.g. for the top level navigation Get started:

pages: [
  {
    title: 'Adobe Analytics',
    path: '/'
  },
  {
    title: 'Guides',
    path: '/guides/'
  },
  {
    title: 'API Reference',
    path: '/api/'
  }
],
subPages: [
  {
    title: 'Get Started',
    path: '/guides/get_started/',
    pages: [
      {
        title: 'Overview',
        path: '/guides/get_started/'
      },
      {
        title: 'Debugging',
        path: '/guides/get_started/debugging/'
      }
    ]
  }
]

This is also necessary if you want to display a categorical Side Navigation using headers as separators. For that you'll have to add the header flag to true on a top level navigation item e.g. :

subPages: [
  {
    title: 'Get Started',
    path: '/guides/get_started/',
    header: true,
    pages: [
      {
        title: 'Overview',
        path: '/guides/get_started/'
      },
      {
        title: 'Debugging',
        path: '/guides/get_started/debugging/'
      }
    ]
  }
]

Similarly to the Global Navigation, the order in which the sub pages are defined is respected in the Side Navigation.

Use descriptive titles

Navigation should be helpful. Choose titles for navigation items that clearly represent the surfaces where they'll go. Avoid using titles that are arbitrary or un-useful, since this can pose usability issues for your product.

Be concise

Along with being descriptive, navigation items should be succinct. Reduce any unnecessary words in order to ensure simplicity. Navigation items should never be so long that they require truncation, except in instances where navigation is user-generated.

Use sentence case

Navigation items should be written in sentence case.

Use the right variation

Make sure that you are using the right variation for your products’ context and users’ needs. Don’t mix behavior, styles, or variations together in a single navigation menu:

• When navigation is simple, use the single-level side navigation.
• When navigation is simple but categorical, use the single-level side navigation with headers.
• When navigation is expansive, hierarchical, and/or you need progressive disclosure in your menu behavior, use the multi-level side navigation.

Avoid deep nested menus

The multi-level side navigation should only go 3 levels deep. More than 3 levels will make the indentation indiscernible, which can become a major usability issue in your product.

Use consistent multi-level behavior

If top-level navigation items have a location associated with them, send the user to that location and open the sub-level navigation items. If a top-level navigation item does not have any associated location, only open the sub-level navigation items.

Side navigation can use either of these behaviors, but should never mix behaviors in the same experience.

Versions

You can specify multiple versions for your site in gatsby-config.js under versions. The first entry is the selected version by default.

versions: [
  {
    title: 'v2.0'
  },
  {
    title: 'v1.4',
    path: 'https://github.com/AdobeDocs/analytics-1.4-apis'
  }
], 

Building the Gatsby site

You can generate a production version of the site using following commands:

With the CLI:

aio doc generate

Or run following commands:

• To build and preview a production version of the site: yarn start.
• To build and preview a production version of the site with path prefix: yarn start:prefix.
• To build and preview a development version of the site with hot reloading: yarn dev.

Adding a Path Prefix

Many applications are hosted at something other than the root (/) of their domain. For example, a Gatsby blog could live at example.com/blog/, or a site could be hosted on GitHub Pages at example.github.io/my-gatsby-site/.

To add a Path Prefix, go to your gatsby-config.js file and specify the prefix with:

pathPrefix: process.env.PATH_PREFIX || '/MY_PREFIX' 

Publishing the Gatsby site

Publishing to GitHub Pages (Dev)

On every commit to the master branch, the site will be built to GitHub Pages automatically, for you to preview as a development version. This is the default for new repos in GitHub: on Oct 1st, this will default to main

GitHub Contributors component: this will use the GitHub token automatically provided by the GitHub Action to retrieve data

Feedback component: no environmental variable should be set since GitHub Pages should only be for development purposes

Publishing to Azure Storage Static Websites (Production)

A site is published via a Pull Request:

1. The Pull Request must be approved
2. The Pull Request should be tagged with the deploy label (Production deploy) AND/OR
3. The Pull Request should be tagged with the deploy:dev label (Dev deploy)

Pre-requisites:

1. Create a GitHub label called deploy if it does not exist
2. Create a GitHub label called deploy:dev if it does not exist
3. Add a Azure Blob Storage connection string GitHub Secret for production called AZURE_PROD_CONNECTION_STRING
4. Add a Azure Blob Storage connection string GitHub Secret for development called AZURE_DEV_CONNECTION_STRING
5. Add a Adobe Launch URL GitHub Secret called GATSBY_LAUNCH_URL (see section above for the Feedback component)
6. The Pull Request must be on a branch in the same repo (this is a GitHub Actions security restriction for secrets access)
7. The person initiating the Pull Request must have a Contributor role to the repo (because of the previous requirement)

Upgrading the theme

To upgrade to the latest version of @adobe/gatsby-theme-parliament, simply run yarn upgrade or npm update if you have defined the dependency with a version range selector. If not, update the version of the dependency by setting the version manually in the package.json and run yarn install or npm install.

This will also update the lock file yarn.lock or package-lock.json.

You can check the latest released version on https://github.com/adobe/gatsby-theme-parliament/releases.

Writing Enhanced Markdown

Front matter support

Front matter allows an author to specify metadata for a page. For example, you can define the page meta title and description by adding front matter to the beginning of your markdown file:

---
title: Guides - Adobe Analytics
description: This is the guides overview page of Adobe Analytics 
---

Specifying external contributors

In addition to the GitHub contributors of a markdown file, you can specify external contributors with front matter. They'll show up first before the GitHub contributors.

---
contributors:
  - https://github.com/simonwex 
---

OpenAPI spec

We use Redoc to render OpenAPI specs. Simply use front matter to define the spec URL.

---
openAPISpec: https://raw.githubusercontent.com/AdobeDocs/analytics-2.0-apis/master/docs/swagger.json
---

JSDoc

We currently recommend to use the jsdoc to markdown converter and annotate your markdown to render JSDoc. Use front matter to specify a JSdoc markdown document.

---
jsDoc: true
---

And annotate your JS parameters with <JsDocParameters/> to render them nicely.

MDX support

MDX is supported out of the box. MDX enables writing JSX React components in markdown giving authors new powers. Despite the markdown files having all an md extension, they are actually treated as MDX files. You can use md and mdx extensions interchangeably.

As we try to limit the use of MDX in favor of pure markdown, we have come up with a way to couple the use of basic markdown syntax with JSX. The JSX blocks are using a slots property to identify which markdown elements to ingest.

Also all JSX blocks are self-closing and using only string properties. This helps maintain better readability when rendered on https://github.com.

Writing a Hero block

A Hero block should be used on every home page. Only 1 Hero block per page is allowed.

There are currently 2 ways to write a Hero block.

1. Using magic rules. If the markdown document starts with an image named hero followed by a heading level 1 and a paragraph, the Hero block will be created automatically.

2. If you need more flexibility e.g. you need to define a specific background color for the Hero, you can use the following syntax:

<Hero slots="image, heading, text" background="rgb(64, 34, 138)"/>

![Hero image](./illustration.png) 

# Adobe Analytics 

Adobe Product API offers limitless ways to integrate your most important customer data into key business processes. Adobe Product API offer limitless ways. 

Use slots to identify the markdown content to be used by the Hero block. The image slot is optional.

Writing a Resources List

Use Resources List to display a side list of links. Those links can point to internal or external documents or pages. Only 1 Resources List per page is allowed.

<Resources slots="heading, links"/>

#### Resources

* [Quickstart Guide](https://www.adobe.io/apis/experiencecloud/analytics/docs.html)
* [Adobe Analytics GitHub Repo](https://github.com/AdobeDocs/analytics-2.0-apis) 

Use slots to identify the markdown content to be used by the Resources List.

Writing a Discover Block

A Discover Block is a section of content that can be used to emphasize certain areas of the page. Multiple Discover Blocks can be displayed in a row.

Single Discover Block

<DiscoverBlock width="100%" slots="heading, link, text"/>

### Get Started

[Quickstart Guide](guides/)
    
Get started with the Adobe Analytics APIs.

Multiple Discover Blocks in a row

<DiscoverBlock slots="heading, link, text"/> 

### Guides

[Calculated Metrics API](guides/calculated_metrics_api/) 
     
Returns information on the user's company that is necessary for making other Adobe Analytics API calls.

<DiscoverBlock slots="link, text"/>

[Segments API](guides/segments_api/) 

Provides configuration guidance and best practices for the /segments endpoint.

<DiscoverBlock slots="link, text"/>

[Reporting Guide API](guides/reporting_api/)

Provides configuration guidance and best practices for the /reports endpoint.

<DiscoverBlock slots="link, text"/> 

Discover Block with image

<DiscoverBlock slots="image, heading, link, text"/>

![Adobe Experience Cloud](experience_cloud.png)

### Developer forum

[Get started](https://adobe.io)

Open discussion and support with community experts and Adobe staff.

<DiscoverBlock slots="link, text"/>

[Experience league](https://adobe.io) 

Tutorials and videos for the community.

Use slots to identify the markdown content to be used by the Discover Block. The heading and image slots are optional.

Writing a Code Block

A Code Block is an enhanced code section which supports additional features like request/response format, multiple languages etc.

<CodeBlock slots="heading, code" repeat="3" languages="JSON, CURL, JSON" /> 

#### Request

```json
{
  "rsid":"adbedocrsid",
  "globalFilters":[
    {
      "type":"dateRange",
      "dateRange":"2017-12-31T00:00:00.000/2018-01-06T23:59:59.999"
    }
  ]
}
```

#### Request

```bash
curl -X POST \
  https://analytics.adobe.io/api/{COMPANYID}/reports \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {APIKEY}' \
  -H 'x-proxy-global-company-id: {COMPANYID}' \
  -d '{REQUESTJSON}'
```

#### Response

```json
{
  "totalPages":1,
  "numberOfElements":7,
  "number":0,
  "totalElements":7
}
```

Use repeat to define how many code sections are part of the Code Block. Use languages to define a language name for each code section. Code sections with the same heading are automatically grouped together.

Writing an Inline Alert

You can use the Inline Alert to visually inform the reader of important content.

<InlineAlert variant="info" slots="text"/>

The refresh token grant type is automatically added to OAuth clients created after September 18, 2019 

Embedding markdown documents and filtering content

You can use MDX transclusion to embed markdown documents into other markdown documents see the MDX documentation.

Embedding local markdown files

For example, if you want to include the content of overview.md into index.md:

index.md content:

import Overview from './overview.md'

# Welcome

Lorem ipsum

<Overview/> 

## Questions

Lorem ipsum

overview.md content:

## Overview

Lorem ipsum

index.md will be rendered as:

# Welcome

Lorem ipsum

## Overview

Lorem ipsum

## Questions

Lorem ipsum

Embedding external markdown files

Gatsby sites are using npm to define dependencies so we can also include external markdown documents.

You have to define a name in the package.json like here to be able to include it as a dependency in another site.

You don't have to release the site on npm since npm supports installing dependencies using github repository urls. For example, to install https://github.com/AdobeDocs/gatsby-theme-parliament-documentation/ as a dependency in another site, you can run the command yarn add adobedocs/gatsby-theme-parliament-documentation;

Your site package will show up under node_modules/[PACKAGE_NAME] e.g. node_modules/gatsby-theme-parliament-documentation.

See full example below using a Variant block.

Filtering content with Variant Blocks

Together with Variant Blocks, the author can query what should be rendered from external sources.

This allows to write content once, and reuse it everywhere.

For example, let's say there are 2 repositories named http://github.com/adobedocs/repo1 and http://github.com/adobedocs/repo2. Both are Gatsby sites using the theme @adobe/gatsby-theme-parliament and have markdown content defined under src/pages.

1. repo1 has reusable markdown content written with Variant Blocks under /src/pages/debugging/index.md:

## How to Debug Your Plugin

Bugs happen! In this tutorial, you will learn how to debug your plugin.

<Variant product="XD" repeat="2" />

First launch the XD console, by clicking Developer > Console

[XD link](https://adobe.io)

<Variant product="Photoshop" repeat="2" />

First launch the Photoshop console, by clicking Developer > Console

[Photoshop link](https://adobe.io)

<Variant test="image" repeat="2" />

#### Image

![image](../test/image.png) 

Use repeat to define how many elements are part of the Variant Block. Use any key=value property to mark your Variant Block.

2. repo2 added repo1 as dependency with yarn add adobedocs/repo1 to be able to reference its markdown content.

3. repo2 embeds repo1 content by using the import statement and inserts the content in its own markdown together with a query filter to only display what is needed.

import Debugging from 'repo1/src/pages/debugging/index.md'

# Debugging

<Debugging query="product=Photoshop" />

More content

will be rendered as:

# Debugging

## How to Debug Your Plugin

Bugs happen! In this tutorial, you will learn how to debug your plugin.

First launch the Photoshop console, by clicking Developer > Console

[Photoshop link](https://adobe.io)

More content

You can query multiple elements, for example you can add the section with the image by adding it to the query.

 <Debugging query="product=Photoshop&image=test" />

Customizations

When using Gatsby themes, you can take advantage of something called Gatsby shadowing. This allows you to override the default component included in the theme with a custom one you’ve created.

The Gatsby Theme Parliament package has a component to render code using the Prism syntax highlighter. With shadowing, you can override the component to provide your own.

If you look at the file tree of your site, you’ll see it looks something like this:

root
├─ src/pages
│   ├- index.md
│   └- etc.
├- .env
├─ gatsby-config.js
└─ package.json 

To enable shadowing, you need to add a folder called @adobe/gatsby-theme-parliament. Any file placed in that directory with a path that matches the path of a file from the theme will completely shadow the file.

So the new folder structure with shadowing enabled will look like following:

root
├─ src
│  ├- pages
│  │  ├- index.md
│  │  └- etc.
│  └- @adobe
│     └- gatsby-theme-parliament
│        └- components
│           └- Code
│              └- index.js        
├- .env
├─ gatsby-config.js
└─ package.json 

You can define your own Code components under src/@adobe/gatsby-theme-parliament/components/Code/index.js.

Notice omitting the src directory in the shadow folder.

Theming

Currently, you can only define a light or dark theme for Code blocks. By default, Code blocks are displayed in dark theme. To change Code blocks from dark to light theme, you have to shadow the theme/index.js file:

export default {
  code: 'light'
}; 

Issue tracker

Use the GitHub issue tracker to report issues, ask questions or log feature requests. Any feedback is welcome !

Please check existing issues before filing anything new.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.