This repo takes all the individual docs that make up the official Svelte tutorial pages, and combines them into one giant single-page document (similar to the official API docs).
- Build command is triggered when it is likely that the Svelte docs have changed
- Use the Github API to check if the tutorial folder was actually modified since last build (compares SHA)
- If SHA has changed, and fresh build is needed, uses
degitpackage to shallow clone the site folder from the official Svelte repo. - Since the contents of the tutorial folder follows a consistent pattern (thanks Svelte team!), it is easy to iterate through contents, extract all the Markdown and meta info, and combine
- Markdown is converted to HTML, and slightly processed (header links injected, styled slightly, etc.)
- Static output (HTML + CSS) is ready to serve!
Clone and install all dependencies, after which you can run npm run build to generate a fresh HTML output.
Thank you to Rich Harris and Svelte contributors for crafting a beautiful framework and some really incredible docs!
- Add in the Svelte Apps for each section - at the very least, a code embed or iframe to hosted version.
More About Me (Joshua Tzucker):