migrate to vitepress (#118)

consolidation · Mar 26, 2024 · 7deaf9a · 7deaf9a
1 parent 7c2322c
commit 7deaf9a
Show file tree

Hide file tree

Showing 45 changed files with 1,609 additions and 4,477 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -0,0 +1,91 @@
+export default ({
+    head: [
+        ['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/favicons/apple-touch-icon.png' }],
+        ['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicons/favicon-32x32.png' }],
+        ['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicons/favicon-16x16.png' }],
+        ['link', { rel: 'shortcut icon', type: 'image/x-icon', href: '/favicon.ico' }],
+        ['link', { rel: 'manifest', href: '/favicons/site.webmanifest' }],
+        ['link', { rel: 'mask-icon', href: '/favicons/safari-pinned-tab.svg', color: '#ffffff' }],
+        ['meta', { name: 'theme-color', content: '#ffffff' }],
+        ['meta', { name: 'msapplication-config', content: '/favicons/browserconfig.xml' }],
+    ],
+
+    lang: 'en-US',
+
+    title: 'Robo',
+
+    themeConfig: {
+
+        nav: [
+            {
+                text: 'Robo Documentation',
+                items: [
+                    { text: "Getting Started", link: "/getting-started.md" },
+                    { text: "Collection", link: "/collections.md" },
+                    { text: "Extending", link: "/extending.md" },
+                    { text: "Robo as a Framework", link: "/framework.md" },
+                ],
+            },
+            {
+                text: 'Tasks',
+                items: [
+                    { text: "ApiGen", link: "/tasks/ApiGen.md" },
+                    { text: "Archive", link: "/tasks/Archive.md" },
+                    { text: "Assets", link: "/tasks/Assets.md" },
+                    { text: "Base", link: "/tasks/Base.md" },
+                    { text: "Bower", link: "/tasks/Bower.md" },
+                    { text: "Composer", link: "/tasks/Composer.md" },
+                    { text: "Development", link: "/tasks/Development.md" },
+                    { text: "Docker", link: "/tasks/Docker.md" },
+                    { text: "File", link: "/tasks/File.md" },
+                    { text: "Filesystem", link: "/tasks/Filesystem.md" },
+                    { text: "Gulp", link: "/tasks/Gulp.md" },
+                    { text: "Logfile", link: "/tasks/Logfile.md" },
+                    { text: "Npm", link: "/tasks/Npm.md" },
+                    { text: "Remote", link: "/tasks/Remote.md" },
+                    { text: "Testing", link: "/tasks/Testing.md" },
+                    { text: "Vcs", link: "/tasks/Vcs.md" },
+                ],
+            },
+            {
+                text: 'Changelog',
+                link: 'https://github.com/consolidation/robo/blob/4.x/CHANGELOG.md',
+            },
+        ],
+        sidebar: [
+            {
+                text: 'Robo Documentation',
+                items: [
+                    { text: "Getting Started", link: "/getting-started.md" },
+                    { text: "Collection", link: "/collections.md" },
+                    { text: "Extending", link: "/extending.md" },
+                    { text: "Robo as a Framework", link: "/framework.md" },
+                ],
+            },
+            {
+                text: 'Tasks',
+                items: [
+                    { text: "ApiGen", link: "/tasks/ApiGen.md" },
+                    { text: "Archive", link: "/tasks/Archive.md" },
+                    { text: "Assets", link: "/tasks/Assets.md" },
+                    { text: "Base", link: "/tasks/Base.md" },
+                    { text: "Bower", link: "/tasks/Bower.md" },
+                    { text: "Composer", link: "/tasks/Composer.md" },
+                    { text: "Development", link: "/tasks/Development.md" },
+                    { text: "Docker", link: "/tasks/Docker.md" },
+                    { text: "File", link: "/tasks/File.md" },
+                    { text: "Filesystem", link: "/tasks/Filesystem.md" },
+                    { text: "Gulp", link: "/tasks/Gulp.md" },
+                    { text: "Logfile", link: "/tasks/Logfile.md" },
+                    { text: "Npm", link: "/tasks/Npm.md" },
+                    { text: "Remote", link: "/tasks/Remote.md" },
+                    { text: "Testing", link: "/tasks/Testing.md" },
+                    { text: "Vcs", link: "/tasks/Vcs.md" },
+                ],
+            },
+        ],
+        footer: {
+            copyright: 'Brought to you by <a href="https://github.com/orgs/consolidation/people">Consolidation Team</a> and our <a href="https://github.com/consolidation/Robo/graphs/contributors">awesome contributors</a> <p>Robo is on <a href="https://twitter.com/robo_php">Twitter</a> and on <a href="https://github.com/consolidation/robo">GitHub</a></p> Projects Using It<span>:</span> <a href="http://codeception.com">Codeception</a> | <a href="http://www.drush.org">Drush</a> | <a href="https://github.com/Codeception/AspectMock">AspectMock</a> | <a href="https://github.com/pantheon-systems/terminus">Pantheon Terminus</a> | <a href="https://github.com/Codeception/CodeceptJS">CodeceptJS</a>'
+        },
+    },
+})
diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css
@@ -0,0 +1,4 @@
+:root {
+    --vp-c-brand-1: #4B7BA0;
+    --vp-button-brand-bg: #4B7BA0;
+}
diff --git a/docs/.vitepress/theme/index.js b/docs/.vitepress/theme/index.js
@@ -0,0 +1,4 @@
+import DefaultTheme from 'vitepress/theme'
+import './custom.css'
+
+export default DefaultTheme
diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts
diff --git a/docs/.vuepress/styles/palette.scss b/docs/.vuepress/styles/palette.scss
diff --git a/docs/docs/collections.md → docs/collections.md b/docs/docs/collections.md → docs/collections.md
diff --git a/docs/docs/extending.md → docs/extending.md b/docs/docs/extending.md → docs/extending.md
diff --git a/docs/docs/framework.md → docs/framework.md b/docs/docs/framework.md → docs/framework.md
diff --git a/docs/docs/getting-started.md → docs/getting-started.md b/docs/docs/getting-started.md → docs/getting-started.md
diff --git a/docs/README.md → docs/index.md b/docs/README.md → docs/index.md
@@ -1,13 +1,19 @@
 ---
-home: true
-title: Home
-actions:
-- text: Get Started
-  link: /docs/index.html
-
-heroImage: /images/robo-logo.svg
-footerHtml: true
-footer: Brought to you by <a href="https://github.com/orgs/consolidation/people">Consolidation Team</a> and our <a href="https://github.com/consolidation/Robo/graphs/contributors">awesome contributors</a> <p>Robo is on <a href="https://twitter.com/robo_php">Twitter</a> and on <a href="https://github.com/consolidation/robo">GitHub</a></p> Projects Using It<span>:</span> <a href="http://codeception.com">Codeception</a> | <a href="http://www.drush.org">Drush</a> | <a href="https://github.com/Codeception/AspectMock">AspectMock</a> | <a href="https://github.com/pantheon-systems/terminus">Pantheon Terminus</a> | <a href="https://github.com/Codeception/CodeceptJS">CodeceptJS</a>
+layout: home
+
+hero:
+    name: Robo
+    text: Modern and simple PHP task runner
+
+    image:
+      src: /images/robo-logo.svg
+      alt: Robo
+
+    actions:
+    - theme: brand
+      text: Get Started
+      link: /links
+
 ---
 
 ## Automate common tasks:

diff --git a/docs/docs/index.md → docs/links.md b/docs/docs/index.md → docs/links.md
@@ -21,4 +21,4 @@
 * [Npm](tasks/Npm.md)
 * [Remote](tasks/Remote.md)
 * [Testing](tasks/Testing.md)
-* [Vcs](tasks/Vcs.md)
+* [Vcs](tasks/Vcs.md)
diff --git a/docs/.vuepress/public/favicon.ico → docs/public/favicon.ico b/docs/.vuepress/public/favicon.ico → docs/public/favicon.ico
diff --git a/...ublic/favicons/android-chrome-192x192.png → ...ublic/favicons/android-chrome-192x192.png b/...ublic/favicons/android-chrome-192x192.png → ...ublic/favicons/android-chrome-192x192.png
diff --git a/...ublic/favicons/android-chrome-512x512.png → ...ublic/favicons/android-chrome-512x512.png b/...ublic/favicons/android-chrome-512x512.png → ...ublic/favicons/android-chrome-512x512.png
diff --git a/...ress/public/favicons/apple-touch-icon.png → docs/public/favicons/apple-touch-icon.png b/...ress/public/favicons/apple-touch-icon.png → docs/public/favicons/apple-touch-icon.png
diff --git a/...uepress/public/favicons/browserconfig.xml → docs/public/favicons/browserconfig.xml b/...uepress/public/favicons/browserconfig.xml → docs/public/favicons/browserconfig.xml
diff --git a/...uepress/public/favicons/favicon-16x16.png → docs/public/favicons/favicon-16x16.png b/...uepress/public/favicons/favicon-16x16.png → docs/public/favicons/favicon-16x16.png
diff --git a/...uepress/public/favicons/favicon-32x32.png → docs/public/favicons/favicon-32x32.png b/...uepress/public/favicons/favicon-32x32.png → docs/public/favicons/favicon-32x32.png
diff --git a/...epress/public/favicons/mstile-144x144.png → docs/public/favicons/mstile-144x144.png b/...epress/public/favicons/mstile-144x144.png → docs/public/favicons/mstile-144x144.png
diff --git a/...epress/public/favicons/mstile-150x150.png → docs/public/favicons/mstile-150x150.png b/...epress/public/favicons/mstile-150x150.png → docs/public/favicons/mstile-150x150.png
diff --git a/...epress/public/favicons/mstile-310x150.png → docs/public/favicons/mstile-310x150.png b/...epress/public/favicons/mstile-310x150.png → docs/public/favicons/mstile-310x150.png
diff --git a/...epress/public/favicons/mstile-310x310.png → docs/public/favicons/mstile-310x310.png b/...epress/public/favicons/mstile-310x310.png → docs/public/favicons/mstile-310x310.png
diff --git a/...vuepress/public/favicons/mstile-70x70.png → docs/public/favicons/mstile-70x70.png b/...vuepress/public/favicons/mstile-70x70.png → docs/public/favicons/mstile-70x70.png
diff --git a/...ess/public/favicons/safari-pinned-tab.svg → docs/public/favicons/safari-pinned-tab.svg b/...ess/public/favicons/safari-pinned-tab.svg → docs/public/favicons/safari-pinned-tab.svg
diff --git a/...vuepress/public/favicons/site.webmanifest → docs/public/favicons/site.webmanifest b/...vuepress/public/favicons/site.webmanifest → docs/public/favicons/site.webmanifest
diff --git a/docs/.vuepress/public/images/logotype.png → docs/public/images/logotype.png b/docs/.vuepress/public/images/logotype.png → docs/public/images/logotype.png
diff --git a/docs/.vuepress/public/images/robo-logo.svg → docs/public/images/robo-logo.svg b/docs/.vuepress/public/images/robo-logo.svg → docs/public/images/robo-logo.svg
diff --git a/docs/docs/tasks/ApiGen.md → docs/tasks/ApiGen.md b/docs/docs/tasks/ApiGen.md → docs/tasks/ApiGen.md
diff --git a/docs/docs/tasks/Archive.md → docs/tasks/Archive.md b/docs/docs/tasks/Archive.md → docs/tasks/Archive.md
diff --git a/docs/docs/tasks/Assets.md → docs/tasks/Assets.md b/docs/docs/tasks/Assets.md → docs/tasks/Assets.md
diff --git a/docs/docs/tasks/Base.md → docs/tasks/Base.md b/docs/docs/tasks/Base.md → docs/tasks/Base.md
diff --git a/docs/docs/tasks/Bower.md → docs/tasks/Bower.md b/docs/docs/tasks/Bower.md → docs/tasks/Bower.md
diff --git a/docs/docs/tasks/Composer.md → docs/tasks/Composer.md b/docs/docs/tasks/Composer.md → docs/tasks/Composer.md
diff --git a/docs/docs/tasks/Development.md → docs/tasks/Development.md b/docs/docs/tasks/Development.md → docs/tasks/Development.md
diff --git a/docs/docs/tasks/Docker.md → docs/tasks/Docker.md b/docs/docs/tasks/Docker.md → docs/tasks/Docker.md
diff --git a/docs/docs/tasks/File.md → docs/tasks/File.md b/docs/docs/tasks/File.md → docs/tasks/File.md
diff --git a/docs/docs/tasks/Filesystem.md → docs/tasks/Filesystem.md b/docs/docs/tasks/Filesystem.md → docs/tasks/Filesystem.md
diff --git a/docs/docs/tasks/Gulp.md → docs/tasks/Gulp.md b/docs/docs/tasks/Gulp.md → docs/tasks/Gulp.md
diff --git a/docs/docs/tasks/Logfile.md → docs/tasks/Logfile.md b/docs/docs/tasks/Logfile.md → docs/tasks/Logfile.md
diff --git a/docs/docs/tasks/Npm.md → docs/tasks/Npm.md b/docs/docs/tasks/Npm.md → docs/tasks/Npm.md
diff --git a/docs/docs/tasks/Remote.md → docs/tasks/Remote.md b/docs/docs/tasks/Remote.md → docs/tasks/Remote.md
diff --git a/docs/docs/tasks/Testing.md → docs/tasks/Testing.md b/docs/docs/tasks/Testing.md → docs/tasks/Testing.md
diff --git a/docs/docs/tasks/Vcs.md → docs/tasks/Vcs.md b/docs/docs/tasks/Vcs.md → docs/tasks/Vcs.md