diff --git a/docs/.gitignore b/docs/.gitignore index 40c6548..b733034 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1 +1,2 @@ -.vitepress +.vitepress/cache +.vitepress/dist diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts new file mode 100644 index 0000000..e96c6bb --- /dev/null +++ b/docs/.vitepress/config.mts @@ -0,0 +1,47 @@ +import {defineConfig} from 'vitepress' + +// https://vitepress.dev/reference/site-config +export default defineConfig({ + title: "LiquipediaClient", + description: "The Liquipedia PHP Client documentation", + lastUpdated: true, + themeConfig: { + editLink: { + pattern: 'https://github.com/npldevfr/liquipedia-client/-/tree/main/docs/:path', + }, + search: { + provider: 'local' + }, + logo: { + dark: '../../images/dark.png', + light: '../../images/light.png' + }, + // nav: [ + // {text: 'Home', link: '/'}, + // {text: 'Examples', link: '/markdown-examples'} + // ], + sidebar: [ + { + text: 'Introduction', + items: [ + {text: 'What is LiquipediaClient?', link: '/guide/what-is-liquipedia-client'}, + {text: 'Getting Started', link: '/guide/getting-started'}, + ] + }, + { + text: 'Endpoints (Coming Soon)', + items: [] + }, + { + text: 'Query Builder', + items: [ + {text: 'Methods', link: '/query-builder/methods'}, + ] + } + ], + + socialLinks: [ + {icon: 'github', link: 'https://github.com/npldevfr/liquipedia-client'}, + ] + } +}) diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css new file mode 100644 index 0000000..161d189 --- /dev/null +++ b/docs/.vitepress/theme/custom.css @@ -0,0 +1,7 @@ +:root { + + --vp-button-brand-bg: #094a81; + --vp-button-brand-hover-bg: #0c5a9b; + --vp-c-brand-1: #0d84e7; + +} diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts new file mode 100644 index 0000000..b6b510b --- /dev/null +++ b/docs/.vitepress/theme/index.ts @@ -0,0 +1,5 @@ +import DefaultTheme from 'vitepress/theme' +import './custom.css' + + +export default DefaultTheme diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md new file mode 100644 index 0000000..db319fd --- /dev/null +++ b/docs/guide/getting-started.md @@ -0,0 +1,16 @@ +--- +outline: deep +--- + +# Getting Started + +## Installation + +The Liquipedia PHP Client can be installed via [Composer](https://getcomposer.org/). + +> Note: Requires PHP 8.2 or higher. + + +```bash +composer require npldevfr/liquipedia-client +``` diff --git a/docs/guide/what-is-liquipedia-client.md b/docs/guide/what-is-liquipedia-client.md new file mode 100644 index 0000000..0ba3d08 --- /dev/null +++ b/docs/guide/what-is-liquipedia-client.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# What is Liquipedia PHP Client? + +The Liquipedia PHP Client serves as a PHP software development kit (SDK) designed to simplify and enhance the utilization of the latest Liquipedia v3 API through custom methods and endpoints. diff --git a/docs/images/dark.png b/docs/images/dark.png index 4602d42..878c72a 100644 Binary files a/docs/images/dark.png and b/docs/images/dark.png differ diff --git a/docs/images/light.png b/docs/images/light.png index e5d2be2..073a34a 100644 Binary files a/docs/images/light.png and b/docs/images/light.png differ diff --git a/docs/images/liquipedia.png b/docs/images/liquipedia.png new file mode 100644 index 0000000..4267f10 Binary files /dev/null and b/docs/images/liquipedia.png differ diff --git a/docs/index.md b/docs/index.md index b913990..2eb1163 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,23 +3,36 @@ layout: home hero: - name: "LiquipediaClient" + name: "Liquipedia PHP Client" text: "" - tagline: "The Liquipedia PHP Client documentation" + tagline: "The v3 Liquipedia API Client for PHP" + image: ./images/liquipedia.png actions: - theme: brand - text: Markdown Examples - link: /markdown-examples + text: Get Started + link: /guide/getting-started - theme: alt - text: API Examples - link: /api-examples + text: Examples + link: /examples features: - - title: Feature A - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature B - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature C - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - title: Easy to use + icon: 🚀 + details: By using the Liquipedia PHP Client you can easily access the Liquipedia API. + - title: Full endpoint support + icon: 📊 + details: The Liquipedia PHP Client supports all Liquipedia API endpoints. + - title: Custom queries + icon: 🔨 + details: Build your own queries to get the data you need. + - title: Extensible + icon: 📦 + details: The Liquipedia PHP Client is extensible and can be used in any PHP project. + - title: Open Source + icon: 📖 + details: The Liquipedia PHP Client is open source and available on GitHub. + - title: Documentation + icon: 📚 + details: The Liquipedia PHP Client has a full documentation with examples. ---