@availity/gatsby-theme-docs
> Shared theme for generating Availity Open Source Documentation
Last updated 9 months ago by availity-bot .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @availity/gatsby-theme-docs 
SYNC missed versions from official npm registry.

Gatsby Theme Docs

Shared theme for generating Availity Open Source Documentation

Configurations

gatsby-config

// Default themeOptions
const themeOptions = require("@availity/gatsby-theme-docs/theme-options');

module.exports = {
  pathPrefix: '/sdk-js', // https://www.gatsbyjs.org/docs/path-prefix/
  __experimentalThemes: [
    {
      resolve: '@availity/gatsby-theme-docs',
      options: {
        ...themeOptions,
        root: __dirname,
        subtitle: 'Availity SDK',
        description:
          'Documentation for Availity Javascript SDK, Rest API and GraphQL',
        githubRepo: 'availity/sdk-js',
        sidebarCategories: {
          'Getting Started': ['index'],
          'API Resources': [
            'api-axios/api-axios',
            'api-core/api-core',
            'localstorage-core/localstorage-core',
          ],
          Upload: ['upload-core/upload-core'],
          Analytics: ['analytics/analytics-core'],
        },
      },
    },
  ],
};
Option name Type Description
root string Must be __dirname
subtitle string The title that gets rendered above the sidebar navigation
description string The site description for SEO and social (FB, Twitter) tags
contentDir string The directory where docs content exists (docs/source by default)
gitType string The repository manager: Github, Bitbucket, or Gitlab
gitRepo string The owner and name of the content repository on Github, Bitbucket, or Gitlab
sidebarCategories object An object mapping categories to page paths ([described below][])
navConfig object An object containing all the navigation items rendered at the top right of the top nav

sidebarCategories

The sidebarCategories option is an object keyed by category titles. Each entry in the object is an array of page paths. The path should resemble the location of a Markdown/MDX file in the git repository, relative to contentDir, and without the .md extension. To add an external link to your sidebar, your can provide a string formatted like a Markdown link.

{
  'Getting Started': [
    'index',
    'getting-started',
    'whats-new'
  ],
  Features: [
    'features/mocking',
    'features/errors',
    'features/data-sources'
  ],
  'External links': [
    '[Principled GraphQL](https://principledgraphql.com/)'
  ]
}

navConfig

The navConfig option is an object keyed by the title of the nav items to be rendered at the top right of the screen in the navigation.

{
    '/availity-workflow': {
        text: 'Getting Started',
        matchRegex: '^/availity-workflow',
  },
  '/availity-uikit': {
        text: 'UI Kit',
        matchRegex: '^/availity-uikit',
  },
}

Creating pages

This theme generates pages based on Markdown or MDX files in the contentDir directory of a repo. Your Markdown/MDX files should contain some frontmatter defining their titles and descriptions.

---
title: Introduction
summary: This is the summary of the introduction.
---

This is some sample markdown that we have below the metadata fields of the markdown file.

Page URLs will be derived from the file paths of your Markdown. You can nest Markdown files within directories to create pages with additional path segments.

Deployment

All docs sites will eventually be deployed into a subdirectory, as configured by the pathPrefix option—/availity-react, for example. Read this guide to learn more about publishing to a subdirectory.

Current Tags

  • 1.4.3-alpha.0                                ...           canary (a year ago)
  • 4.0.2                                ...           latest (9 months ago)

35 Versions

  • 4.0.2                                ...           9 months ago
  • 4.0.1                                ...           10 months ago
  • 4.0.0                                ...           a year ago
  • 3.0.2                                ...           a year ago
  • 3.0.1                                ...           a year ago
  • 3.0.0                                ...           a year ago
  • 2.0.3                                ...           a year ago
  • 2.0.2                                ...           a year ago
  • 2.0.1                                ...           a year ago
  • 2.0.0                                ...           a year ago
  • 1.4.13                                ...           a year ago
  • 1.4.12                                ...           a year ago
  • 1.4.11                                ...           a year ago
  • 1.4.10                                ...           a year ago
  • 1.4.9                                ...           a year ago
  • 1.4.8                                ...           a year ago
  • 1.4.7                                ...           a year ago
  • 1.4.6                                ...           a year ago
  • 1.4.5                                ...           a year ago
  • 1.4.4                                ...           a year ago
  • 1.4.3                                ...           a year ago
  • 1.4.3-alpha.0                                ...           a year ago
  • 1.4.2                                ...           a year ago
  • 1.4.1                                ...           a year ago
  • 1.4.1-alpha.3                                ...           a year ago
  • 1.4.0                                ...           a year ago
  • 1.3.3                                ...           a year ago
  • 1.3.2                                ...           a year ago
  • 1.3.1                                ...           a year ago
  • 1.3.0                                ...           a year ago
  • 1.2.6                                ...           a year ago
  • 1.2.5                                ...           a year ago
  • 1.2.4                                ...           a year ago
  • 1.2.3                                ...           a year ago
  • 1.2.2                                ...           a year ago

Copyright 2014 - 2016 © taobao.org |