Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

migrate to vitepress #118

Merged
merged 1 commit into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -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>'
},
},
})
4 changes: 4 additions & 0 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
:root {
--vp-c-brand-1: #4B7BA0;
--vp-button-brand-bg: #4B7BA0;
}
4 changes: 4 additions & 0 deletions docs/.vitepress/theme/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
129 changes: 0 additions & 129 deletions docs/.vuepress/config.ts

This file was deleted.

13 changes: 0 additions & 13 deletions docs/.vuepress/styles/palette.scss

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
24 changes: 15 additions & 9 deletions docs/README.md → docs/index.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/index.md → docs/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
* [Npm](tasks/Npm.md)
* [Remote](tasks/Remote.md)
* [Testing](tasks/Testing.md)
* [Vcs](tasks/Vcs.md)
* [Vcs](tasks/Vcs.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading
Loading