From e01855b89b2e8c23b53f337c5a84ea0a1d5c5cc4 Mon Sep 17 00:00:00 2001 From: Ollie Taylor <13766232+OllieJT@users.noreply.github.com> Date: Sun, 9 Jul 2023 22:18:06 +0100 Subject: [PATCH] Initial Docs (#39) --- .prettierrc | 2 +- .vscode/settings.json | 3 +- README.md | 135 +- package.json | 44 +- pnpm-lock.yaml | 1782 +++++++++++++++-- postcss.config.cjs | 11 + src/app.d.ts | 10 +- src/app.html | 11 +- src/app.postcss | 225 +++ src/content/__test.svx | 58 + src/content/components/anchor.svelte | 16 + .../components/content-list-item.svelte | 19 + src/content/components/content-title.svelte | 11 + src/content/components/content.svelte | 8 + src/content/components/features.svelte | 29 + src/content/components/index.ts | 6 + src/content/components/section-title.svelte | 9 + src/content/components/section.svelte | 9 + src/content/docs.md | 184 ++ src/content/episodes.ts | 14 + src/content/example/add-loader.svelte | 9 + src/content/example/index.ts | 5 + src/content/example/load-audio-click.svelte | 16 + src/content/example/load-audio-mount.svelte | 11 + src/content/utility/anchor-registry.ts | 36 + src/content/utility/code-opts.ts | 8 + src/globals.d.ts | 8 + src/lib/audio/audio-element.ts | 2 +- src/lib/audio/episode-data.ts | 8 +- src/routes/+layout.svelte | 60 + src/routes/+layout.ts | 2 + src/routes/+page.server.ts | 8 + src/routes/+page.svelte | 226 +-- src/routes/another-page/+page.svelte | 108 - src/routes/demo/+page.svelte | 262 +++ src/routes/demo/preview-component.svelte | 20 + src/routes/demo/preview-data-code.svelte | 6 + src/routes/demo/preview-data.svelte | 14 + src/routes/hljs-svelte.ts | 56 + src/routes/use-markdown.ts | 103 + static/favicon.png | Bin 3179 -> 0 bytes static/icon-512.png | Bin 145777 -> 0 bytes static/icon.png | Bin 0 -> 11936 bytes static/icon.svg | 77 - static/icon@2x.png | Bin 0 -> 37746 bytes static/logo.png | Bin 0 -> 17762 bytes static/logo@2x.png | Bin 0 -> 50927 bytes static/svelte-podcast-avatar.png | Bin 316852 -> 153420 bytes static/svelte-podcast-graphic.png | Bin 864345 -> 507059 bytes svelte.config.js | 12 +- tailwind.config.cjs | 26 + 51 files changed, 3056 insertions(+), 613 deletions(-) create mode 100644 postcss.config.cjs create mode 100644 src/app.postcss create mode 100644 src/content/__test.svx create mode 100644 src/content/components/anchor.svelte create mode 100644 src/content/components/content-list-item.svelte create mode 100644 src/content/components/content-title.svelte create mode 100644 src/content/components/content.svelte create mode 100644 src/content/components/features.svelte create mode 100644 src/content/components/index.ts create mode 100644 src/content/components/section-title.svelte create mode 100644 src/content/components/section.svelte create mode 100644 src/content/docs.md create mode 100644 src/content/episodes.ts create mode 100644 src/content/example/add-loader.svelte create mode 100644 src/content/example/index.ts create mode 100644 src/content/example/load-audio-click.svelte create mode 100644 src/content/example/load-audio-mount.svelte create mode 100644 src/content/utility/anchor-registry.ts create mode 100644 src/content/utility/code-opts.ts create mode 100644 src/globals.d.ts create mode 100644 src/routes/+layout.ts create mode 100644 src/routes/+page.server.ts delete mode 100644 src/routes/another-page/+page.svelte create mode 100644 src/routes/demo/+page.svelte create mode 100644 src/routes/demo/preview-component.svelte create mode 100644 src/routes/demo/preview-data-code.svelte create mode 100644 src/routes/demo/preview-data.svelte create mode 100644 src/routes/hljs-svelte.ts create mode 100644 src/routes/use-markdown.ts delete mode 100644 static/favicon.png delete mode 100644 static/icon-512.png create mode 100644 static/icon.png delete mode 100644 static/icon.svg create mode 100644 static/icon@2x.png create mode 100644 static/logo.png create mode 100644 static/logo@2x.png create mode 100644 tailwind.config.cjs diff --git a/.prettierrc b/.prettierrc index adc6cbc..1d5daee 100644 --- a/.prettierrc +++ b/.prettierrc @@ -3,7 +3,7 @@ "singleQuote": true, "trailingComma": "all", "printWidth": 100, - "plugins": ["prettier-plugin-svelte"], + "plugins": ["prettier-plugin-svelte", "prettier-plugin-tailwindcss"], "svelteSortOrder": "options-scripts-styles-markup", "svelteBracketNewLine": true, "svelteIndentScriptAndStyle": true, diff --git a/.vscode/settings.json b/.vscode/settings.json index e18140a..886822e 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -24,5 +24,6 @@ "problems.sortOrder": "severity", "todo-tree.tree.scanMode": "workspace only", "javascript.preferences.importModuleSpecifier": "relative", - "typescript.preferences.importModuleSpecifier": "relative" + "typescript.preferences.importModuleSpecifier": "relative", + "files.associations": { ".env*": "dotenv", "*.svx": "mdx", "*.md": "mdx" } } diff --git a/README.md b/README.md index 7c249cd..8931eec 100644 --- a/README.md +++ b/README.md @@ -39,13 +39,13 @@ In no particular order, here are some of the things I'm confident will be added ```bash # with npm -npm install svelte-podcast +npm install svelte-podcast@latest # with yarn -yarn add svelte-podcast +yarn add svelte-podcast@latest # with pnpm -pnpm add svelte-podcast +pnpm add svelte-podcast@latest ``` You must add one instance of the `` to your app. This should be places as high as possible, ideally in your root `+layout,svelte` file. @@ -62,129 +62,10 @@ You must add one instance of the `` to your app. This should be p #### Basic usage -You will likely be interacting with svelte-podcast via one of the stores it exports. - -```html - -``` - -#### `audio` store - -##### `subscribe` - -```html - -``` - -##### methods - -###### play / pause - -`audio.play()` to play the currently loaded audio, or `audio.play("toggle")` to toggle play/pause. - -`audio.pause()` to pause the currently loaded audio, or `audio.pause("toggle")` to toggle play/pause. - -###### mute / unmute - -`audio.mute()` to mute the audio for the `