Spotify.NET/SpotifyAPI.Docs
2023-11-03 22:43:54 +01:00
..
.vscode Update documentation 2022-05-21 21:04:46 +02:00
docs Replace port 5000 (often used) with 5543, fixes #868 2023-05-27 21:43:01 +02:00
src bump docs to 7.X 2022-11-27 14:31:18 +01:00
static/img Update documentation 2022-05-21 21:04:46 +02:00
versioned_docs/version-5.1.1 Updated docusaurus and fixed some links 2021-04-08 21:44:18 +02:00
versioned_sidebars switch to pnpm and update packages 2023-11-03 22:43:54 +01: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 switch to pnpm and update packages 2023-11-03 22:43:54 +01:00
docusaurus.config.js bump docs to 7.X 2022-11-27 14:31:18 +01:00
package.json switch to pnpm and update packages 2023-11-03 22:43:54 +01:00
pnpm-lock.yaml switch to pnpm and update packages 2023-11-03 22:43:54 +01:00
README.md switch to pnpm and update packages 2023-11-03 22:43:54 +01:00
reference.md Update online docs 2020-06-03 17:44:13 +02:00
sidebars.js Added migration from 5.x to 6.x to docs 2020-11-14 13:19:20 +01:00
versions.json Updated docusaurus and fixed some links 2021-04-08 21:44:18 +02:00

Website

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

Installation

$ pnpm

Local Development

$ pnpm 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

$ pnpm 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 pnpm 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.