Stan's Assets API website

This project is used to maintain the docfx project for the Web Stan's Assets API

How to use

• Website is located under the docs folder.
• Make sure docfx is installed. (for example if you are using mac Homebrew run brew install docfx). Or check DocFX section for more details.
• To regenerate the website content, remove files under the docs folder, run docfx docfx-project/docfx.json
• If you want to preview created site locally, run docfx docfx-project/docfx.json -t statictoc
• Make sure you have the following repos on the same level
• • Plugins
• • com.stansassets.foundation

Example

Here is a good example of how to connect a new package to the documentation website. There were only 2 simple steps to add com.stansassets.build documentation generation. See the examples below:

• Commit to the current repo
• Commit it the com.stansassets.build repo

DocFx

• Getting Started Guide
• Themes

Other nice looking static websites powered by DocFx

• Testify Git repo | Website

Github pages

Static site will be hoster from the master branch / master branch docs folder / gh-pages branch (whatever you prefer in the settings.)

Subdomain set up:

• Repo Options - set custom subdomain to api.stansassets.com
• Add domain CNAME record: api / stansassets.github.io

Tutorials / Info

• How to Use a GoDaddy Custom Subdomain with GitHub Pages Hosting

• Using custom domain for GitHub pages

• Does GitHub Pages Support HTTPS for www and @ subdomains?