Spotify.NET/SpotifyAPI.Docs
2022-01-25 20:32:12 +01:00
..
docs Add ConcertBuddy project to Showcase (#729) 2022-01-25 20:32:12 +01:00
src Updated docusaurus and fixed some links 2021-04-08 21:44:18 +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 Updated docusaurus and fixed some links 2021-04-08 21:44:18 +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 Use webfactory/ssh-agent for the SSH setup 2020-11-14 11:14:24 +01:00
docusaurus.config.js Update docs dependencies 2021-08-10 22:23:31 +02:00
package.json Update docs dependencies 2021-08-10 22:23:31 +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 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
yarn.lock Bump nanoid from 3.1.22 to 3.2.0 in /SpotifyAPI.Docs (#726) 2022-01-25 20:30:46 +01: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.