From 4aa4d35362b1cf09f69655a0febf0058cf989c74 Mon Sep 17 00:00:00 2001 From: sam Date: Mon, 21 Aug 2023 15:57:23 +0200 Subject: [PATCH] move self-hosting documentation to docs site --- docs-site/api-examples.md | 49 ----------- {docs => docs-site/config-examples}/Caddyfile | 0 .../config-examples}/pronouns-api.service | 0 .../config-examples}/pronouns-clean.service | 0 .../config-examples}/pronouns-clean.timer | 0 .../pronouns-exporter.service | 0 .../config-examples}/pronouns-fe.service | 0 .../config-examples}/pronounscc.nginx | 0 docs-site/markdown-examples.md | 85 ------------------- .../self-hosting.md | 2 +- 10 files changed, 1 insertion(+), 135 deletions(-) delete mode 100644 docs-site/api-examples.md rename {docs => docs-site/config-examples}/Caddyfile (100%) rename {docs => docs-site/config-examples}/pronouns-api.service (100%) rename {docs => docs-site/config-examples}/pronouns-clean.service (100%) rename {docs => docs-site/config-examples}/pronouns-clean.timer (100%) rename {docs => docs-site/config-examples}/pronouns-exporter.service (100%) rename {docs => docs-site/config-examples}/pronouns-fe.service (100%) rename {docs => docs-site/config-examples}/pronounscc.nginx (100%) delete mode 100644 docs-site/markdown-examples.md rename docs/production.md => docs-site/self-hosting.md (98%) diff --git a/docs-site/api-examples.md b/docs-site/api-examples.md deleted file mode 100644 index 6bd8bb5..0000000 --- a/docs-site/api-examples.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -outline: deep ---- - -# Runtime API Examples - -This page demonstrates usage of some of the runtime APIs provided by VitePress. - -The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files: - -```md - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
-``` - - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
- -## More - -Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata). diff --git a/docs/Caddyfile b/docs-site/config-examples/Caddyfile similarity index 100% rename from docs/Caddyfile rename to docs-site/config-examples/Caddyfile diff --git a/docs/pronouns-api.service b/docs-site/config-examples/pronouns-api.service similarity index 100% rename from docs/pronouns-api.service rename to docs-site/config-examples/pronouns-api.service diff --git a/docs/pronouns-clean.service b/docs-site/config-examples/pronouns-clean.service similarity index 100% rename from docs/pronouns-clean.service rename to docs-site/config-examples/pronouns-clean.service diff --git a/docs/pronouns-clean.timer b/docs-site/config-examples/pronouns-clean.timer similarity index 100% rename from docs/pronouns-clean.timer rename to docs-site/config-examples/pronouns-clean.timer diff --git a/docs/pronouns-exporter.service b/docs-site/config-examples/pronouns-exporter.service similarity index 100% rename from docs/pronouns-exporter.service rename to docs-site/config-examples/pronouns-exporter.service diff --git a/docs/pronouns-fe.service b/docs-site/config-examples/pronouns-fe.service similarity index 100% rename from docs/pronouns-fe.service rename to docs-site/config-examples/pronouns-fe.service diff --git a/docs/pronounscc.nginx b/docs-site/config-examples/pronounscc.nginx similarity index 100% rename from docs/pronounscc.nginx rename to docs-site/config-examples/pronounscc.nginx diff --git a/docs-site/markdown-examples.md b/docs-site/markdown-examples.md deleted file mode 100644 index 8e55eb8..0000000 --- a/docs-site/markdown-examples.md +++ /dev/null @@ -1,85 +0,0 @@ -# Markdown Extension Examples - -This page demonstrates some of the built-in markdown extensions provided by VitePress. - -## Syntax Highlighting - -VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting: - -**Input** - -```` -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` -```` - -**Output** - -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` - -## Custom Containers - -**Input** - -```md -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: -``` - -**Output** - -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: - -## More - -Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown). diff --git a/docs/production.md b/docs-site/self-hosting.md similarity index 98% rename from docs/production.md rename to docs-site/self-hosting.md index 9afe530..a658d67 100644 --- a/docs/production.md +++ b/docs-site/self-hosting.md @@ -1,6 +1,6 @@ # Running pronouns.cc in production -The configuration files in this directory are the same files used to run pronouns.cc in production. +The configuration files in this directory are the same files used to run pronouns.cc in production. You might have to change paths and ports, but they should work fine as-is. ## Building pronouns.cc