Skip to content

Commit

Permalink
feat: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
npldevfr committed Jan 30, 2024
1 parent b5b865f commit 0806980
Show file tree
Hide file tree
Showing 10 changed files with 109 additions and 13 deletions.
3 changes: 2 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.vitepress
.vitepress/cache
.vitepress/dist
47 changes: 47 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -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'},
]
}
})
7 changes: 7 additions & 0 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:root {

--vp-button-brand-bg: #094a81;
--vp-button-brand-hover-bg: #0c5a9b;
--vp-c-brand-1: #0d84e7;

}
5 changes: 5 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'


export default DefaultTheme
16 changes: 16 additions & 0 deletions docs/guide/getting-started.md
Original file line number Diff line number Diff line change
@@ -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
```
7 changes: 7 additions & 0 deletions docs/guide/what-is-liquipedia-client.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file modified docs/images/dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/liquipedia.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 25 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---

0 comments on commit 0806980

Please sign in to comment.