rename demo to docs

stereobooster · Dec 4, 2024 · edcb57f · edcb57f
1 parent ba74e2f
commit edcb57f
Show file tree

Hide file tree

Showing 45 changed files with 28 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ Ideas for other diagrams: [Text to Diagram](https://stereobooster.com/posts/text
 - [x] [@beoe/remark-code-hook](/packages/remark-code-hook/)
 - [x] [@beoe/pan-zoom](/packages/pan-zoom/)
 - [x] [@beoe/fenceparser](/packages/fenceparser/)
+- [x] [docs](/packages/docs/) [![Netlify Status](https://api.netlify.com/api/v1/badges/14126476-0cdb-4802-9a5b-e7f598221650/deploy-status)](https://app.netlify.com/sites/beoe/deploys)
 
 ## Logo
 

diff --git a/packages/demo/.gitignore → packages/docs/.gitignore b/packages/demo/.gitignore → packages/docs/.gitignore
diff --git a/packages/demo/.vscode/extensions.json → packages/docs/.vscode/extensions.json b/packages/demo/.vscode/extensions.json → packages/docs/.vscode/extensions.json
diff --git a/packages/demo/.vscode/launch.json → packages/docs/.vscode/launch.json b/packages/demo/.vscode/launch.json → packages/docs/.vscode/launch.json
diff --git a/packages/demo/README.md → packages/docs/README.md b/packages/demo/README.md → packages/docs/README.md
diff --git a/packages/demo/astro.config.mjs → packages/docs/astro.config.mjs b/packages/demo/astro.config.mjs → packages/docs/astro.config.mjs
diff --git a/packages/demo/package.json → packages/docs/package.json b/packages/demo/package.json → packages/docs/package.json
diff --git a/packages/demo/public/favicon.svg → packages/docs/public/favicon.svg b/packages/demo/public/favicon.svg → packages/docs/public/favicon.svg
diff --git a/packages/demo/public/logo-dark.svg → packages/docs/public/logo-dark.svg b/packages/demo/public/logo-dark.svg → packages/docs/public/logo-dark.svg
diff --git a/packages/demo/public/logo.svg → packages/docs/public/logo.svg b/packages/demo/public/logo.svg → packages/docs/public/logo.svg
diff --git a/packages/demo/src/components/PageFrame.astro → packages/docs/src/components/PageFrame.astro b/packages/demo/src/components/PageFrame.astro → packages/docs/src/components/PageFrame.astro
diff --git a/packages/demo/src/components/graphviz.ts → packages/docs/src/components/graphviz.ts b/packages/demo/src/components/graphviz.ts → packages/docs/src/components/graphviz.ts
diff --git a/packages/demo/src/components/panzoom.ts → packages/docs/src/components/panzoom.ts b/packages/demo/src/components/panzoom.ts → packages/docs/src/components/panzoom.ts
diff --git a/packages/demo/src/components/vizdom.ts → packages/docs/src/components/vizdom.ts b/packages/demo/src/components/vizdom.ts → packages/docs/src/components/vizdom.ts
diff --git a/packages/demo/src/content/config.ts → packages/docs/src/content/config.ts b/packages/demo/src/content/config.ts → packages/docs/src/content/config.ts
diff --git a/...ges/demo/src/content/docs/diagrams/d2.mdx → ...ges/docs/src/content/docs/diagrams/d2.mdx b/...ges/demo/src/content/docs/diagrams/d2.mdx → ...ges/docs/src/content/docs/diagrams/d2.mdx
@@ -74,3 +74,7 @@ You can create small Netlify plugin to install D2. See example [here](https://gi
 - [ ] [Export JSON graph](https://github.com/terrastruct/d2/discussions/2224)
 - [ ] [Class-based dark mode](https://github.com/terrastruct/d2/discussions/2225)
 - [ ] Link resolution callback
+
+## TODO
+
+- [ ] add documentation about `d2Options`
diff --git a/...emo/src/content/docs/diagrams/gnuplot.mdx → ...ocs/src/content/docs/diagrams/gnuplot.mdx b/...emo/src/content/docs/diagrams/gnuplot.mdx → ...ocs/src/content/docs/diagrams/gnuplot.mdx
diff --git a/...mo/src/content/docs/diagrams/graphviz.mdx → ...cs/src/content/docs/diagrams/graphviz.mdx b/...mo/src/content/docs/diagrams/graphviz.mdx → ...cs/src/content/docs/diagrams/graphviz.mdx
@@ -93,7 +93,7 @@ Check out other [options](/start-here/configuration/).
 
 ### Configuration
 
-You probaly want to use `inline` strategy and implement dark scheme via CSS:
+You probaly want to use [`inline`](/start-here/strategy/#inline) strategy and implement dark scheme via CSS:
 
 ```css
 .graphviz {

diff --git a/...emo/src/content/docs/diagrams/mermaid.mdx → ...ocs/src/content/docs/diagrams/mermaid.mdx b/...emo/src/content/docs/diagrams/mermaid.mdx → ...ocs/src/content/docs/diagrams/mermaid.mdx
diff --git a/...demo/src/content/docs/diagrams/vizdom.mdx → ...docs/src/content/docs/diagrams/vizdom.mdx b/...demo/src/content/docs/diagrams/vizdom.mdx → ...docs/src/content/docs/diagrams/vizdom.mdx
@@ -145,7 +145,7 @@ Check out other [options](/start-here/configuration/).
 
 ### Configuration
 
-You probaly want to use `inline` strategy and implement dark scheme via CSS:
+You probaly want to use [`inline`](/start-here/strategy/#inline) strategy and implement dark scheme via CSS:
 
 ```css
 .vizdom {
@@ -180,3 +180,7 @@ You probaly want to use `inline` strategy and implement dark scheme via CSS:
 - [ ] [HTML classes are not supported](https://github.com/vizdom-dev/vizdom/issues/11)
 - [ ] [Text is transformed to path, so <kbd>Cmd</kbd> + <kbd>F</kbd> doesn't work](https://github.com/vizdom-dev/vizdom/issues/12)
 - [ ] Doesn't support some unicode chars, like `label="∅"`
+
+## TODO
+
+- [ ] Maybe rename `dataGraph` to `graphFormat`. And documentation for it
diff --git a/...demo/src/content/docs/examples/d2-test.md → ...docs/src/content/docs/examples/d2-test.md b/...demo/src/content/docs/examples/d2-test.md → ...docs/src/content/docs/examples/d2-test.md
diff --git a/...src/content/docs/examples/gnuplot-test.md → ...src/content/docs/examples/gnuplot-test.md b/...src/content/docs/examples/gnuplot-test.md → ...src/content/docs/examples/gnuplot-test.md
diff --git a/...rc/content/docs/examples/graphviz-test.md → ...rc/content/docs/examples/graphviz-test.md b/...rc/content/docs/examples/graphviz-test.md → ...rc/content/docs/examples/graphviz-test.md
diff --git a/...src/content/docs/examples/mermaid-test.md → ...src/content/docs/examples/mermaid-test.md b/...src/content/docs/examples/mermaid-test.md → ...src/content/docs/examples/mermaid-test.md
diff --git a/.../src/content/docs/examples/vizdom-test.md → .../src/content/docs/examples/vizdom-test.md b/.../src/content/docs/examples/vizdom-test.md → .../src/content/docs/examples/vizdom-test.md
diff --git a/packages/demo/src/content/docs/index.mdx → packages/docs/src/content/docs/index.mdx b/packages/demo/src/content/docs/index.mdx → packages/docs/src/content/docs/index.mdx
diff --git a/...src/content/docs/notes/graph-libraries.md → ...src/content/docs/notes/graph-libraries.md b/...src/content/docs/notes/graph-libraries.md → ...src/content/docs/notes/graph-libraries.md
diff --git a/...demo/src/content/docs/notes/space-time.md → ...docs/src/content/docs/notes/space-time.md b/...demo/src/content/docs/notes/space-time.md → ...docs/src/content/docs/notes/space-time.md
diff --git a/...ages/demo/src/content/docs/other/cache.md → ...ages/docs/src/content/docs/other/cache.md b/...ages/demo/src/content/docs/other/cache.md → ...ages/docs/src/content/docs/other/cache.md
diff --git a/...emo/src/content/docs/other/fenceparser.md → ...ocs/src/content/docs/other/fenceparser.md b/...emo/src/content/docs/other/fenceparser.md → ...ocs/src/content/docs/other/fenceparser.md
diff --git a/...s/demo/src/content/docs/other/pan-zoom.md → ...s/docs/src/content/docs/other/pan-zoom.md b/...s/demo/src/content/docs/other/pan-zoom.md → ...s/docs/src/content/docs/other/pan-zoom.md
@@ -179,3 +179,7 @@ Be aware that some CSS will cause pixelation of SVG on zoom (bug in Safari), for
 - `will-change: transform;`
 - `transform: matrix3d(...);`
 - `transition-property: transform;` (it setles after animation, though)
+
+## TODO
+
+- [ ] some kind of threshold for small images (pan-zoom UI looks weird for small images)
diff --git a/...rc/content/docs/other/rehype-code-hook.md → ...rc/content/docs/other/rehype-code-hook.md b/...rc/content/docs/other/rehype-code-hook.md → ...rc/content/docs/other/rehype-code-hook.md
diff --git a/...rc/content/docs/other/remark-code-hook.md → ...rc/content/docs/other/remark-code-hook.md b/...rc/content/docs/other/remark-code-hook.md → ...rc/content/docs/other/remark-code-hook.md
diff --git a/...emo/src/content/docs/other/sqlitecache.md → ...ocs/src/content/docs/other/sqlitecache.md b/...emo/src/content/docs/other/sqlitecache.md → ...ocs/src/content/docs/other/sqlitecache.md
diff --git a/...content/docs/start-here/accessibility.mdx → ...content/docs/start-here/accessibility.mdx b/...content/docs/start-here/accessibility.mdx → ...content/docs/start-here/accessibility.mdx
@@ -8,7 +8,7 @@ import { Tabs, TabItem } from "@astrojs/starlight/components";
 
 ## Alt
 
-Works only with `strategy=file` and `strategy=data-url`.
+Works only with strategy [`file`](/start-here/strategy/#file) and [`data-url`](/start-here/strategy/#data-url)
 
 <Tabs>
   <TabItem label="Markdown">
@@ -61,6 +61,7 @@ graph LR
   <desc>Bob's Burgers process for making big decisions</desc>
 </svg>
 ```
+
   </TabItem>
   <TabItem label="Diagram">
 ```mermaid strategy=inline
@@ -71,4 +72,3 @@ graph LR
 ```
   </TabItem>
 </Tabs>
-
diff --git a/.../content/docs/start-here/configuration.md → .../content/docs/start-here/configuration.md b/.../content/docs/start-here/configuration.md → .../content/docs/start-here/configuration.md
diff --git a/...c/content/docs/start-here/dark-scheme.mdx → ...c/content/docs/start-here/dark-scheme.mdx b/...c/content/docs/start-here/dark-scheme.mdx → ...c/content/docs/start-here/dark-scheme.mdx
@@ -66,11 +66,11 @@ html[data-theme="dark"] .beoe-light {
 
 ## Strategy vs dark scheme
 
-|            | `class`   | `media` |
-| ---------- | --------- | ------- |
-| `inline`   | maybe (1) | no      |
-| `data-url` | yes       | yes     |
-| `file`     | yes       | yes     |
+|                                              | `class`   | `media` |
+| -------------------------------------------- | --------- | ------- |
+| [`inline`](/start-here/strategy/#inline)     | maybe (1) | no      |
+| [`data-url`](/start-here/strategy/#data-url) | yes       | yes     |
+| [`file`](/start-here/strategy/#file)         | yes       | yes     |
 
 (1) - for example, works for Mermaid, but doesn't work for D2 (check with light mode):
 
@@ -83,6 +83,7 @@ import { Tabs, TabItem } from "@astrojs/starlight/components";
 direction: right
 a -> b -> c -> d -> e
 ```
+
   </TabItem>
   <TabItem label="Markdown">
 
@@ -92,5 +93,6 @@ direction: right
 a -> b -> c -> d -> e
 ```
 ````
+
   </TabItem>
 </Tabs>
diff --git a/...ontent/docs/start-here/getting-started.md → ...ontent/docs/start-here/getting-started.md b/...ontent/docs/start-here/getting-started.md → ...ontent/docs/start-here/getting-started.md
diff --git a/...content/docs/start-here/interactivity.mdx → ...content/docs/start-here/interactivity.mdx b/...content/docs/start-here/interactivity.mdx → ...content/docs/start-here/interactivity.mdx
@@ -6,7 +6,7 @@ sidebar:
 
 import { Tabs, TabItem } from "@astrojs/starlight/components";
 
-Works only with `strategy=inline`.
+Works only with strategy [`inline`](/start-here/strategy/#inline).
 
 ## Searchable text
 

diff --git a/...o/src/content/docs/start-here/strategy.md → ...s/src/content/docs/start-here/strategy.md b/...o/src/content/docs/start-here/strategy.md → ...s/src/content/docs/start-here/strategy.md
diff --git a/...tent/docs/start-here/styling-with-css.mdx → ...tent/docs/start-here/styling-with-css.mdx b/...tent/docs/start-here/styling-with-css.mdx → ...tent/docs/start-here/styling-with-css.mdx
@@ -6,7 +6,7 @@ sidebar:
 
 import { Tabs, TabItem } from "@astrojs/starlight/components";
 
-Works only with `strategy=inline`.
+Works only with strategy [`inline`](/start-here/strategy/#inline).
 
 **Basic idea**: you can target with CSS any SVG node, something like this:
 

diff --git a/packages/demo/src/env.d.ts → packages/docs/src/env.d.ts b/packages/demo/src/env.d.ts → packages/docs/src/env.d.ts
diff --git a/packages/demo/src/styles/custom.css → packages/docs/src/styles/custom.css b/packages/demo/src/styles/custom.css → packages/docs/src/styles/custom.css
diff --git a/packages/demo/tsconfig.json → packages/docs/tsconfig.json b/packages/demo/tsconfig.json → packages/docs/tsconfig.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml