Skip to content

zeroheight-demos/sitemap-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

zeroheight Sitemap and RSS Feed Generator

Generate full sitemaps for your design system using the zeroheight API.

Demo | Further reading

Deploy to Netlify

Deploy with Vercel

Features

  • Creates a sitemap.xml file for your design system's styleguide
  • Creates a rss.xml file as a feed for your design system's releases
  • Can be hosted on small instances on platforms such as Netlify and Vercel
  • All achieved using a single vanilla Node JavaScript file
  • Can be configured to be rebuild upon each chance of a styleguide

Installation

  1. Use the deployment options listed above, or fork this repo
  2. Add the following environment variables to your deployment setup or when cloning your fork locally:
KEY="YOURZEROHEIGHTAPIKEY"
CLIENT="YOURZEROHEIGHTCLIENTID"
STYLEGUIDE="YOURZEROHEIGHTSTYLEGUIDEID"
STYLEGUIDE_TITLE="The Preferred Title Of Your Styleguide"
STYLEGUIDE_URL="https://yourstyleguideurl.com"

These can be generated by following our developers guide

  1. Submit these variables and wait for the deployment to complete, or if cloned locally run npm run build

Options

Currently the only option is --path to change the build output directory, build/ is the default

About

Generate full sitemaps for your design system using the zeroheight API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •