@sfdocs-internal/theme-apihub

Salesforce API Hub Theme

Usage no npm install needed!

<script type="module">
  import sfdocsInternalThemeApihub from 'https://cdn.skypack.dev/@sfdocs-internal/theme-apihub';
</script>

README

CircleCI npm version

README

This repository contains the Theme for Developer Website to be used in conjunction with the doc-framework.

Getting started

  1. Install the local app

Working on the site

(Optionally) Setup your Credentials to pull external repositories

For OpenDocs, their content is in external github repositories, often private. This means you'll need a local github certificates file which you can read about in Credential Setup

Note: If you do not do this step, the yarn start:portal command will not work and you will not be able to see content for the site that is coming from open docs. (Only /docs/apis/* urls)

Starting the site

Building of the theme is necessary the first time

yarn build

The site itself does not need a build, so any changes to content do not require re-running this command. Changes to the theme do though.

Starting the site in preview mode

yarn start

Starting the site in portal mode

yarn start:portal

Making changes

When making changes to content, the site will automatically reload.

When making changes to the look and feel, you'll need to run a separate command to start watching for changes to the site assets.

yarn watch

This will cause the theme for the website to be compiled and output to the appropriate output folder.

For changes to the components, you'll need to see the DSC Components Repository.

More docs