From 7cb0f8e9156ad8e9d566f997b57b08940097f5c8 Mon Sep 17 00:00:00 2001 From: Richard Harris Date: Mon, 11 Mar 2019 23:12:44 -0400 Subject: [PATCH] add stuff --- site/content/docs/02-compile-time.md | 11 ++++++ site/content/docs/03-run-time.md | 46 ++++++++++++++++++++++ site/content/docs/99-outline.md | 59 ---------------------------- 3 files changed, 57 insertions(+), 59 deletions(-) create mode 100644 site/content/docs/02-compile-time.md create mode 100644 site/content/docs/03-run-time.md delete mode 100644 site/content/docs/99-outline.md diff --git a/site/content/docs/02-compile-time.md b/site/content/docs/02-compile-time.md new file mode 100644 index 0000000000..4f578332f8 --- /dev/null +++ b/site/content/docs/02-compile-time.md @@ -0,0 +1,11 @@ +--- +title: Compile time +--- + +### svelte.preprocess + +TODO + +### svelte.compile + +TODO diff --git a/site/content/docs/03-run-time.md b/site/content/docs/03-run-time.md new file mode 100644 index 0000000000..09d8382eaf --- /dev/null +++ b/site/content/docs/03-run-time.md @@ -0,0 +1,46 @@ +--- +title: Run time +--- + +TODO + +### Client-side component API + +* `const component = new Component(options);` +* `component.$set(...);` +* `component.$on(event, callback);` +* `component.$destroy();` +* `component.x` if `accessors: true` + + +### Server-side component API + +* `const result = Component.render(...)` + + +### svelte + +* lifecycle methods, tick, context +* SSR behaviour + + +### svelte/store + +* writable, readable, derive, get + +### svelte/motion + +* spring, tweened + +### svelte/transition + +* fade, fly, slide, draw +* crossfade... + +### svelte/animation + +* TODO this doesn't even exist yet + +### svelte/easing + +* TODO could have nice little interactive widgets showing the different functions, maybe \ No newline at end of file diff --git a/site/content/docs/99-outline.md b/site/content/docs/99-outline.md deleted file mode 100644 index 57d2197387..0000000000 --- a/site/content/docs/99-outline.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Outline ---- - -(This isn't the actual documentation, this is just me getting my thoughts straight so that we can create the documentation.) - -I think it makes sense to split the docs into component format (script, style, markup), compile time (`svelte.preprocess` and `svelte.compile`), then run time (component API, `svelte`, `svelte/store`, `svelte/motion`, etc). I'm not sure where template syntax, style scoping (and `:global(...)`), `context="module"` etc goes. - - -### Component format - -* .svelte -* `