Spotify.NET/SpotifyAPI.Docs
2020-06-16 20:50:04 +02:00
..
docs Removed invalid syntax from pagination docs 2020-06-15 22:39:43 +02:00
src Prepare 6.0.0-beta.6 2020-06-16 20:50:04 +02:00
static/img Adapted readme for version 6 beta 2020-06-04 21:32:52 +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
docs.sh Added git config stuff 2020-06-04 18:34:19 +02:00
docusaurus.config.js Corrected github docs settings 2020-06-04 16:21:23 +02:00
package.json Docs site updated #451 2020-05-31 17:21:17 +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 docs for IPlayableItem, fixes #454 2020-06-06 17:43:49 +02:00
versions.json Started docs 2020-05-13 18:27:16 +02:00
yarn.lock Bump websocket-extensions from 0.1.3 to 0.1.4 in /SpotifyAPI.Docs (#457) 2020-06-07 10:15:44 +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.