Spotify.NET/SpotifyAPI.Docs
2020-11-14 09:40:07 +01:00
..
docs Fix typo (#533) 2020-11-13 22:56:56 +01:00
src prepare last last beta - beta.11 2020-08-20 14:10:33 +02:00
static/img Finished PKCE Docs & Implementation - Example.CLI.PersistentConfig now uses PKCE 2020-08-19 14:03:01 +02:00
versioned_docs/version-5.1.1 Merge branch 'v6' 2020-06-04 15:43:25 +02:00
versioned_sidebars Started docs 2020-05-13 18:27:16 +02:00
.gitignore Started docs 2020-05-13 18:27:16 +02:00
.prettierrc.json Docs formatting 2020-08-19 14:12:11 +02:00
docs.sh Added first workflows for building docs and ci/cd 2020-11-14 09:40:07 +01:00
docusaurus.config.js Corrected github docs settings 2020-06-04 16:21:23 +02:00
package.json Docs formatting 2020-08-19 14:12:11 +02:00
README.md Started docs 2020-05-13 18:27:16 +02:00
reference.md Update online docs 2020-06-03 17:44:13 +02:00
sidebars.js Added PKCE stuff: Initial request & refresh + PKCEUtil for generating verifiers 2020-08-06 18:48:49 +00:00
versions.json Started docs 2020-05-13 18:27:16 +02:00
yarn.lock Bump http-proxy from 1.18.0 to 1.18.1 in /SpotifyAPI.Docs (#504) 2020-09-10 21:30:43 +02:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.