Skip to content

This project is to convert the existing SPotify Web API documentation into MkDocs. During this effort I plan to better understand the abilities and limitations of MkDocs and its plug-ins.

Notifications You must be signed in to change notification settings

PastranaDigital/Spotify-API-as-MkDocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Spotify API as MkDocs

This project is to convert the existing SPotify Web API documentation into MkDocs. During this effort I plan to better understand the abilities and limitations of MkDocs and its plug-ins.

This repository implements a GitHub workflow that publishes my changes to the GitHub page on merge.



Links

Where it began: https://developer.spotify.com/documentation/web-api

My conversion: https://pastranadigital.github.io/Spotify-API-as-MkDocs/



MkDocs Lessons Learned

  1. Using custom stylesheets to control the visibility of "Table of Contents" for all pages
  2. Controlling the order of the navgiation utilizing the "Awesome Pages" plugin
  3. Linking between pages thru folders
  4. Setting image width using img html code does not render with MkDocs
  5. Compatibiltiy with Light or Dark mode using material toggle
  6. Enabling site-wide search
  7. Customized to use Logo and Favicon
  8. Displaying multiple code examples in tabbed layout

About

This project is to convert the existing SPotify Web API documentation into MkDocs. During this effort I plan to better understand the abilities and limitations of MkDocs and its plug-ins.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published