docs: migrate from vuepress to nuxt content (#133)

master
Alba Silvente Fuentes 2020-10-09 12:11:26 +02:00 committed by GitHub
parent 304dd4ee02
commit 2fa2776d31
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
24 changed files with 4811 additions and 3020 deletions

11
docs/.gitignore vendored
View File

@ -1 +1,10 @@
.vuepress/dist node_modules
*.iml
.idea
*.log*
.nuxt
.vscode
.DS_Store
coverage
dist
sw.*

View File

@ -1,54 +0,0 @@
module.exports = {
title: 'HTTP Module',
description: 'Universal HTTP Module for Nuxt',
themeConfig: {
repo: 'nuxt/http',
docsDir: 'docs',
editLinks: true,
editLinkText: 'Edit this page on GitHub',
displayAllHeaders: false,
sidebar: {
'/guide/': [
{
collapsable: false,
children: [
'/guide/',
'/guide/usage',
'/guide/advanced',
'/guide/migration'
]
}
],
'/api/': [
{
collapsable: false,
children: [
'/api/',
'/api/runtime-config',
'/api/helpers',
'/api/hooks',
'/api/http-methods'
]
}
],
'/': [
['/', 'Introduction'],
['/guide/', 'Guide'],
['/api/', 'API']
]
},
nav: [
{
text: 'Guide',
link: '/guide/'
},
{
text: 'API',
link: '/api/'
}, {
text: 'Release Notes',
link: 'https://github.com/nuxt/http/blob/dev/CHANGELOG.md'
}
]
}
}

View File

@ -1,4 +1,9 @@
# Advanced ---
title: Advanced
description: 'Advanced concepts'
position: 4
category: Getting Started
---
## Hooks ## Hooks
@ -58,15 +63,19 @@ export default function ({ $http }) {
Globally set a header to all subsequent requests. Globally set a header to all subsequent requests.
:::warning <alert type="warning">
This method should probably not be called inside hooks as it is global and will apply to all future requests
::: This method should probably not be called inside hooks as it is global and will apply to all future requests
</alert>
<alert type="tip">
:::tip
Please note that HTTP headers are case-insensitive. Therefore all header names will be converted to lower-case to make sure that if you set the same header twice but with different casing the last one set will be used. Please note that HTTP headers are case-insensitive. Therefore all header names will be converted to lower-case to make sure that if you set the same header twice but with different casing the last one set will be used.
See also [this comment](https://github.com/sindresorhus/ky/issues/105#issuecomment-470169100) in the Ky repository for more information See also [this comment](https://github.com/sindresorhus/ky/issues/105#issuecomment-470169100) in the Ky repository for more information
:::
</alert>
Parameters: Parameters:
@ -91,9 +100,11 @@ this.$http.setHeader('Content-Type', false)
Globally set `Authorization` header to all subsequent requests. Globally set `Authorization` header to all subsequent requests.
:::tip Note <alert type="tip">
This is a global method, you only have to call it once after which all future requests will include the token This is a global method, you only have to call it once after which all future requests will include the token
:::
</alert>
Parameters: Parameters:
@ -118,8 +129,7 @@ this.$http.setToken(false)
If you need to create your own [ky instance](https://github.com/sindresorhus/ky#kycreatedefaultoptions) which based on `$http` defaults, you can use the `create(options)` method. If you need to create your own [ky instance](https://github.com/sindresorhus/ky#kycreatedefaultoptions) which based on `$http` defaults, you can use the `create(options)` method.
```js ```js{}[plugins/github.js]
// plugins/github.js
export default function ({ $http, env }, inject) { export default function ({ $http, env }, inject) {
// Create a custom HTTP instance // Create a custom HTTP instance
const $github = $http.create({ const $github = $http.create({

View File

@ -1,8 +1,15 @@
# Helpers ---
title: Helpers
description: 'Helpers available on $http instance.'
position: 7
category: API
---
<alert type="tip">
:::tip Note
Helpers available on `$http` instance. Helpers available on `$http` instance.
:::
</alert>
## `setBaseURL` ## `setBaseURL`

View File

@ -1,4 +1,9 @@
# Hooks ---
title: Hooks
description: 'Hooks with arguments.'
position: 8
category: API
---
The `arguments` listed below are those your hook will receive when it's called. The `arguments` listed below are those your hook will receive when it's called.

View File

@ -1,13 +1,21 @@
---
title: HTTP Methods
description: 'HTTP Methods'
position: 9
category: API
---
## HTTP Methods <alert type="tip">
:::tip Usage
See [here](/guide/usage.html#making-requests) for usage information for below methods. See [here](/guide/usage.html#making-requests) for usage information for below methods.
:::
:::tip Note </alert>
<alert type="tip">
Each http method returns a `Promise` Each http method returns a `Promise`
:::
</alert>
### `delete` ### `delete`
### `get` ### `get`

28
docs/content/en/index.md Normal file
View File

@ -0,0 +1,28 @@
---
title: Introduction
description: 'HTTP module for Nuxt.js provides a universal way to make HTTP requests to the API backend.'
position: 1
category: ''
menuTitle: 'Intro'
features:
- The fluent ky API has been extended with enhancements and shortcuts
- Highly customizable options support for `BaseURL`
- Automatically proxy cookies and headers when making requests from server side
- Best practices to avoid token sharing when making server side requests
- Easy proxy support to avoid CORS problems and making deployment easier
---
HTTP module for Nuxt.js provides a universal way to make HTTP requests to the API backend.
This module is an alternative to [Axios Module](https://github.com/nuxt-community/axios-module). Behind the scenes it use [ky-universal](https://github.com/sindresorhus/ky-universal) and [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) to make HTTP requests. Please see the [migration guide](./guide/migration) if you are currently using axios module and wish to migrate.
Starting from [v2.5.0](https://github.com/nuxt/nuxt.js/releases/tag/v2.5.0), Nuxt.js has built-in support for universal fetch. However, this module provides several advantages:
## Features
<list :items="features"></list>
## Links
* [ky](https://github.com/sindresorhus/ky)
* [`BaseURL`](/api/#baseurl)

View File

@ -1,10 +1,17 @@
# Migration Guide ---
title: Migration Guides
description: 'How to migrate from Axios module'
position: 10
category: Migration
---
This guide will help you to migrate from [Axios Module](https://github.com/nuxt-community/axios-module). This guide will help you to migrate from [Axios Module](https://github.com/nuxt-community/axios-module).
:::tip Note <alert type="tip">
The nuxt-community axios module is still supported and maintained. The HTTP module uses newer web technologies like fetch which might be beneficial The nuxt-community axios module is still supported and maintained. The HTTP module uses newer web technologies like fetch which might be beneficial
:::
</alert>
## Differences ## Differences

View File

@ -1,4 +1,9 @@
# Options ---
title: Options
description: 'You can pass options using module options or http section in nuxt.config.js'
position: 5
category: API
---
You can pass options using module options or `http` section in `nuxt.config.js` You can pass options using module options or `http` section in `nuxt.config.js`
@ -28,9 +33,11 @@ Base URL which is used and prepended to make requests in server side.
Environment variable `API_URL` can be used to **override** `baseURL`. Environment variable `API_URL` can be used to **override** `baseURL`.
:::tip Note <alert type="tip">
`baseURL` and `proxy` won't work together, you will need to use [`prefix`](/api/#prefix) instead `baseURL` and `proxy` won't work together, you will need to use [`prefix`](/api/#prefix) instead
:::
</alert>
## `browserBaseURL` ## `browserBaseURL`
@ -77,11 +84,14 @@ You can easily integrate HTTP with [Proxy Module](https://github.com/nuxt-commun
} }
``` ```
:::tip Note <alert type="tip">
It is not required to manually register `@nuxtjs/proxy` module, but it does need to be in your dependencies
::: It is not required to manually register `@nuxtjs/proxy` module, but it does need to be in your dependencies
</alert>
<alert type="tip">
:::tip Note
`/api/` will be added to all requests to the API end point. If you need to remove it use `pathRewrite`: `/api/` will be added to all requests to the API end point. If you need to remove it use `pathRewrite`:
```js ```js
@ -92,7 +102,8 @@ proxy: {
} }
} }
``` ```
:::
</alert>
## `retry` ## `retry`
@ -142,9 +153,11 @@ In SSR context, sets client request header as http default request headers.
This is useful for making requests which need cookie based auth on server side. This is useful for making requests which need cookie based auth on server side.
Also helps making consistent requests in both SSR and Client Side code. Also helps making consistent requests in both SSR and Client Side code.
:::tip Note <alert type="tip">
When directing requests at a url protected by CloudFlare's CDN you should set this to `false` to prevent CloudFlare from mistakenly detecting a reverse proxy loop and returning a 403 error. When directing requests at a url protected by CloudFlare's CDN you should set this to `false` to prevent CloudFlare from mistakenly detecting a reverse proxy loop and returning a 403 error.
:::
</alert>
## `proxyHeadersIgnore` ## `proxyHeadersIgnore`
@ -158,10 +171,14 @@ Headers added to all requests. If provided, will be merged with the defaults.
* Default: `{}` * Default: `{}`
:::tip Note <alert type="tip">
Do NOT include any credentials or tokens here. One can easily access them.
::: Do NOT include any credentials or tokens here. One can easily access them.
</alert>
<alert type="tip">
:::tip Note
This headers are effective to ALL requests. Please take care and consider providing special headers on each call that needs this unless you are pretty sure you always need to add headers. This headers are effective to ALL requests. Please take care and consider providing special headers on each call that needs this unless you are pretty sure you always need to add headers.
:::
</alert>

View File

@ -1,4 +1,9 @@
# Runtime Config ---
title: Runtime Config
description: 'The use of runtime config is mandatory in case of using environment variables in production.'
position: 6
category: API
---
The use of [runtime config](https://nuxtjs.org/guide/runtime-config) is mandatory in case of using environment variables in production. Otherwise, the values will be hard coded during build and won't change until the next build. The use of [runtime config](https://nuxtjs.org/guide/runtime-config) is mandatory in case of using environment variables in production. Otherwise, the values will be hard coded during build and won't change until the next build.

View File

@ -1,8 +1,13 @@
# Setup ---
title: Setup
description: 'How to setup your module'
position: 2
category: Getting Started
---
Check the [Nuxt.js documentation](https://nuxtjs.org/api/configuration-modules#the-modules-property) for more information about installing and using modules in Nuxt.js Check the [Nuxt.js documentation](https://nuxtjs.org/api/configuration-modules#the-modules-property) for more information about installing and using modules in Nuxt.js
## Installation ## Install
Install with yarn: Install with yarn:
@ -34,6 +39,8 @@ module.exports = {
See [http's options](/api/#options). See [http's options](/api/#options).
::: warning <alert type="warning">
Note that this module does not currently support IE 11 because of using [ky](https://github.com/sindresorhus/ky) ([open issue](https://github.com/nuxt/http/issues/126)) Note that this module does not currently support IE 11 because of using [ky](https://github.com/sindresorhus/ky) ([open issue](https://github.com/nuxt/http/issues/126))
:::
</alert>

View File

@ -1,4 +1,9 @@
# Usage ---
title: Usage
description: 'How to use this module'
position: 3
category: Getting Started
---
## Making Requests ## Making Requests
@ -58,9 +63,11 @@ async asyncData({ $http }) {
## Using in Component Methods ## Using in Component Methods
:::warning Note <alert type="warning">
`this` is not available in Nuxt's `asyncData` method, see [using in `asyncData`](#using-in-asyncdata) for how to use this module in `asyncData` `this` is not available in Nuxt's `asyncData` method, see [using in `asyncData`](#using-in-asyncdata) for how to use this module in `asyncData`
:::
</alert>
When you have access to `this`, you can use `this.$http`: When you have access to `this`, you can use `this.$http`:
@ -89,4 +96,4 @@ For store actions you can also use `this.$http`:
} }
} }
} }
``` ```

View File

@ -0,0 +1,10 @@
{
"title": "Http Module",
"url": "https://http.nuxtjs.org/",
"logo": {
"light": "/logo-light.svg",
"dark": "/logo-dark.svg"
},
"github": "nuxt/http",
"twitter": "@nuxt_js"
}

3
docs/nuxt.config.js Normal file
View File

@ -0,0 +1,3 @@
import theme from '@nuxt/content-theme-docs'
export default theme({})

View File

@ -1,10 +1,15 @@
{ {
"name": "docs",
"version": "1.0.0",
"private": true, "private": true,
"scripts": { "scripts": {
"dev": "vuepress dev", "dev": "nuxt",
"build": "vuepress build" "build": "nuxt build",
"start": "nuxt start",
"generate": "nuxt generate"
}, },
"devDependencies": { "dependencies": {
"vuepress": "^1.6.0" "@nuxt/content-theme-docs": "^0.6.0",
"nuxt": "^2.14.6"
} }
} }

View File

@ -1,13 +1,27 @@
# Introduction # docs
HTTP module for Nuxt.js provides a universal way to make HTTP requests to the API backend. ## Setup
This module is an alternative to [Axios Module](https://github.com/nuxt-community/axios-module). Behind the scenes it use [ky-universal](https://github.com/sindresorhus/ky-universal) and [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) to make HTTP requests. Please see the [migration guide](./guide/migration) if you are currently using axios module and wish to migrate. Install dependencies:
Starting from [v2.5.0](https://github.com/nuxt/nuxt.js/releases/tag/v2.5.0), Nuxt.js has built-in support for universal fetch. However, this module provides several advantages: ```bash
yarn install
```
- The fluent [ky](https://github.com/sindresorhus/ky) API has been extended with enhancements and shortcuts ## Development
- Highly customizable options support for [`BaseURL`](/api/#baseurl)
- Automatically proxy cookies and headers when making requests from server side ```bash
- Best practices to avoid token sharing when making server side requests yarn dev
- Easy proxy support to avoid CORS problems and making deployment easier ```
## Static Generation
This will create the `dist/` directory for publishing to static hosting:
```bash
yarn generate
```
To preview the static generated app, run `yarn start`
For detailed explanation on how things work, checkout [nuxt/content](https://content.nuxtjs.org) and [@nuxt/content theme docs](https://content.nuxtjs.org/themes-docs).

BIN
docs/static/icon.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

10
docs/static/logo-dark.svg vendored Normal file
View File

@ -0,0 +1,10 @@
<svg width="188" height="40" viewBox="0 0 188 40" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M50.82 30V16.112H53.984L54.264 18.464C54.6933 17.6427 55.3093 16.9893 56.112 16.504C56.9333 16.0187 57.8947 15.776 58.996 15.776C60.7133 15.776 62.048 16.3173 63 17.4C63.952 18.4827 64.428 20.0693 64.428 22.16V30H60.844V22.496C60.844 21.3013 60.6013 20.3867 60.116 19.752C59.6307 19.1173 58.8747 18.8 57.848 18.8C56.84 18.8 56.0093 19.1547 55.356 19.864C54.7213 20.5733 54.404 21.5627 54.404 22.832V30H50.82ZM73.0632 30.336C71.3272 30.336 69.9832 29.7947 69.0312 28.712C68.0978 27.6293 67.6312 26.0427 67.6312 23.952V16.112H71.1872V23.616C71.1872 24.8107 71.4298 25.7253 71.9152 26.36C72.4005 26.9947 73.1658 27.312 74.2112 27.312C75.2005 27.312 76.0125 26.9573 76.6472 26.248C77.3005 25.5387 77.6272 24.5493 77.6272 23.28V16.112H81.2112V30H78.0472L77.7672 27.648C77.3378 28.4693 76.7125 29.1227 75.8912 29.608C75.0885 30.0933 74.1458 30.336 73.0632 30.336ZM83.5743 30L88.6143 23.056L83.5743 16.112H87.4103L90.9383 21.04L94.4383 16.112H98.3023L93.2343 23.056L98.3023 30H94.4383L90.9383 25.072L87.4103 30H83.5743ZM106.774 30C105.318 30 104.151 29.6453 103.274 28.936C102.396 28.2267 101.958 26.9667 101.958 25.156V19.108H99.5776V16.112H101.958L102.378 12.388H105.542V16.112H109.294V19.108H105.542V25.184C105.542 25.856 105.682 26.3227 105.962 26.584C106.26 26.8267 106.764 26.948 107.474 26.948H109.21V30H106.774ZM111.195 33.108L118.195 8.244H121.695L114.667 33.108H111.195Z" fill="white"/>
<path d="M124.156 30V9.84H127.74V18.24C128.207 17.4747 128.832 16.8773 129.616 16.448C130.419 16 131.333 15.776 132.36 15.776C134.077 15.776 135.403 16.3173 136.336 17.4C137.288 18.4827 137.764 20.0693 137.764 22.16V30H134.208V22.496C134.208 21.3013 133.965 20.3867 133.48 19.752C133.013 19.1173 132.267 18.8 131.24 18.8C130.232 18.8 129.392 19.1547 128.72 19.864C128.067 20.5733 127.74 21.5627 127.74 22.832V30H124.156ZM147.379 30C145.923 30 144.756 29.6453 143.879 28.936C143.002 28.2267 142.563 26.9667 142.563 25.156V19.108H140.183V16.112H142.563L142.983 12.388H146.147V16.112H149.899V19.108H146.147V25.184C146.147 25.856 146.287 26.3227 146.567 26.584C146.866 26.8267 147.37 26.948 148.079 26.948H149.815V30H147.379ZM159.164 30C157.708 30 156.542 29.6453 155.664 28.936C154.787 28.2267 154.348 26.9667 154.348 25.156V19.108H151.968V16.112H154.348L154.768 12.388H157.932V16.112H161.684V19.108H157.932V25.184C157.932 25.856 158.072 26.3227 158.352 26.584C158.651 26.8267 159.155 26.948 159.864 26.948H161.6V30H159.164ZM164.761 36.16V16.112H167.953L168.345 18.1C168.793 17.484 169.381 16.9427 170.109 16.476C170.856 16.0093 171.817 15.776 172.993 15.776C174.3 15.776 175.467 16.0933 176.493 16.728C177.52 17.3627 178.332 18.2307 178.929 19.332C179.527 20.4333 179.825 21.684 179.825 23.084C179.825 24.484 179.527 25.7347 178.929 26.836C178.332 27.9187 177.52 28.7773 176.493 29.412C175.467 30.028 174.3 30.336 172.993 30.336C171.948 30.336 171.033 30.14 170.249 29.748C169.465 29.356 168.831 28.8053 168.345 28.096V36.16H164.761ZM172.237 27.2C173.376 27.2 174.319 26.8173 175.065 26.052C175.812 25.2867 176.185 24.2973 176.185 23.084C176.185 21.8707 175.812 20.872 175.065 20.088C174.319 19.304 173.376 18.912 172.237 18.912C171.08 18.912 170.128 19.304 169.381 20.088C168.653 20.8533 168.289 21.8427 168.289 23.056C168.289 24.2693 168.653 25.268 169.381 26.052C170.128 26.8173 171.08 27.2 172.237 27.2Z" fill="#41B38A"/>
<mask id="mask0" mask-type="alpha" maskUnits="userSpaceOnUse" x="8" y="5" width="30" height="30">
<path d="M9.76911 8.7992C10.0036 7.7909 10.7909 7.0036 11.7992 6.76911C19.1681 5.05541 26.8319 5.05541 34.2008 6.76911C35.2091 7.0036 35.9964 7.7909 36.2309 8.7992C37.9446 16.1681 37.9446 23.8319 36.2309 31.2008C35.9964 32.2091 35.2091 32.9964 34.2008 33.2309C26.8319 34.9446 19.1681 34.9446 11.7992 33.2309C10.7909 32.9964 10.0036 32.2091 9.76911 31.2008C8.05541 23.8319 8.05541 16.1681 9.76911 8.7992Z" fill="#00DC82" stroke="black" stroke-width="0.32"/>
</mask>
<g mask="url(#mask0)">
<path fill-rule="evenodd" clip-rule="evenodd" d="M27.9369 4.60376H7.52832V32.9828L10.4534 36H22.4372L32.4888 30.1967C33.0893 29.85 33.295 29.0822 32.9483 28.4817L27.3068 18.7104C26.9601 18.1099 27.1659 17.3421 27.7663 16.9954L31.2791 14.9673C31.8795 14.6206 32.6474 14.8264 32.9941 15.4268L39 25.8295V5.8387C38.9349 5.86292 38.871 5.89289 38.8088 5.92878L22.0798 15.5873C21.4793 15.934 21.2736 16.7018 21.6203 17.3023L27.2618 27.0736C27.6085 27.6741 27.4027 28.4419 26.8022 28.7886L23.2649 30.8309C22.6644 31.1776 21.8966 30.9718 21.5499 30.3714L12.6167 14.8986C12.27 14.2981 12.4757 13.5303 13.0762 13.1836L27.9369 4.60376ZM35.6041 36L39 34.0394V36H35.6041Z" fill="#00DC82"/>
</g>
</svg>

After

Width:  |  Height:  |  Size: 4.6 KiB

10
docs/static/logo-light.svg vendored Normal file
View File

@ -0,0 +1,10 @@
<svg width="245" height="40" viewBox="0 0 245 40" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M50.82 30V16.112H53.984L54.264 18.464C54.6933 17.6427 55.3093 16.9893 56.112 16.504C56.9333 16.0187 57.8947 15.776 58.996 15.776C60.7133 15.776 62.048 16.3173 63 17.4C63.952 18.4827 64.428 20.0693 64.428 22.16V30H60.844V22.496C60.844 21.3013 60.6013 20.3867 60.116 19.752C59.6307 19.1173 58.8747 18.8 57.848 18.8C56.84 18.8 56.0093 19.1547 55.356 19.864C54.7213 20.5733 54.404 21.5627 54.404 22.832V30H50.82ZM73.0632 30.336C71.3272 30.336 69.9832 29.7947 69.0312 28.712C68.0978 27.6293 67.6312 26.0427 67.6312 23.952V16.112H71.1872V23.616C71.1872 24.8107 71.4298 25.7253 71.9152 26.36C72.4005 26.9947 73.1658 27.312 74.2112 27.312C75.2005 27.312 76.0125 26.9573 76.6472 26.248C77.3005 25.5387 77.6272 24.5493 77.6272 23.28V16.112H81.2112V30H78.0472L77.7672 27.648C77.3378 28.4693 76.7125 29.1227 75.8912 29.608C75.0885 30.0933 74.1458 30.336 73.0632 30.336ZM83.5743 30L88.6143 23.056L83.5743 16.112H87.4103L90.9383 21.04L94.4383 16.112H98.3023L93.2343 23.056L98.3023 30H94.4383L90.9383 25.072L87.4103 30H83.5743ZM106.774 30C105.318 30 104.151 29.6453 103.274 28.936C102.396 28.2267 101.958 26.9667 101.958 25.156V19.108H99.5776V16.112H101.958L102.378 12.388H105.542V16.112H109.294V19.108H105.542V25.184C105.542 25.856 105.682 26.3227 105.962 26.584C106.26 26.8267 106.764 26.948 107.474 26.948H109.21V30H106.774ZM111.195 33.108L118.195 8.244H121.695L114.667 33.108H111.195Z" fill="#003C3C"/>
<path d="M124.156 30V9.84H127.74V18.24C128.207 17.4747 128.832 16.8773 129.616 16.448C130.419 16 131.333 15.776 132.36 15.776C134.077 15.776 135.403 16.3173 136.336 17.4C137.288 18.4827 137.764 20.0693 137.764 22.16V30H134.208V22.496C134.208 21.3013 133.965 20.3867 133.48 19.752C133.013 19.1173 132.267 18.8 131.24 18.8C130.232 18.8 129.392 19.1547 128.72 19.864C128.067 20.5733 127.74 21.5627 127.74 22.832V30H124.156ZM147.379 30C145.923 30 144.756 29.6453 143.879 28.936C143.002 28.2267 142.563 26.9667 142.563 25.156V19.108H140.183V16.112H142.563L142.983 12.388H146.147V16.112H149.899V19.108H146.147V25.184C146.147 25.856 146.287 26.3227 146.567 26.584C146.866 26.8267 147.37 26.948 148.079 26.948H149.815V30H147.379ZM159.164 30C157.708 30 156.542 29.6453 155.664 28.936C154.787 28.2267 154.348 26.9667 154.348 25.156V19.108H151.968V16.112H154.348L154.768 12.388H157.932V16.112H161.684V19.108H157.932V25.184C157.932 25.856 158.072 26.3227 158.352 26.584C158.651 26.8267 159.155 26.948 159.864 26.948H161.6V30H159.164ZM164.761 36.16V16.112H167.953L168.345 18.1C168.793 17.484 169.381 16.9427 170.109 16.476C170.856 16.0093 171.817 15.776 172.993 15.776C174.3 15.776 175.467 16.0933 176.493 16.728C177.52 17.3627 178.332 18.2307 178.929 19.332C179.527 20.4333 179.825 21.684 179.825 23.084C179.825 24.484 179.527 25.7347 178.929 26.836C178.332 27.9187 177.52 28.7773 176.493 29.412C175.467 30.028 174.3 30.336 172.993 30.336C171.948 30.336 171.033 30.14 170.249 29.748C169.465 29.356 168.831 28.8053 168.345 28.096V36.16H164.761ZM172.237 27.2C173.376 27.2 174.319 26.8173 175.065 26.052C175.812 25.2867 176.185 24.2973 176.185 23.084C176.185 21.8707 175.812 20.872 175.065 20.088C174.319 19.304 173.376 18.912 172.237 18.912C171.08 18.912 170.128 19.304 169.381 20.088C168.653 20.8533 168.289 21.8427 168.289 23.056C168.289 24.2693 168.653 25.268 169.381 26.052C170.128 26.8173 171.08 27.2 172.237 27.2Z" fill="#41B38A"/>
<mask id="mask0" mask-type="alpha" maskUnits="userSpaceOnUse" x="8" y="5" width="30" height="30">
<path d="M9.76911 8.7992C10.0036 7.7909 10.7909 7.0036 11.7992 6.76911C19.1681 5.05541 26.8319 5.05541 34.2008 6.76911C35.2091 7.0036 35.9964 7.7909 36.2309 8.7992C37.9446 16.1681 37.9446 23.8319 36.2309 31.2008C35.9964 32.2091 35.2091 32.9964 34.2008 33.2309C26.8319 34.9446 19.1681 34.9446 11.7992 33.2309C10.7909 32.9964 10.0036 32.2091 9.76911 31.2008C8.05541 23.8319 8.05541 16.1681 9.76911 8.7992Z" fill="#00DC82" stroke="black" stroke-width="0.32"/>
</mask>
<g mask="url(#mask0)">
<path fill-rule="evenodd" clip-rule="evenodd" d="M27.9369 4.60376H7.52832V32.9829L10.4534 36H22.4373L32.4888 30.1968C33.0893 29.8501 33.295 29.0822 32.9483 28.4818L27.3068 18.7104C26.9601 18.1099 27.1659 17.3421 27.7663 16.9954L31.2791 14.9674C31.8795 14.6207 32.6474 14.8264 32.9941 15.4269L39 25.8295V5.83872C38.9349 5.86294 38.871 5.89291 38.8088 5.9288L22.0798 15.5873C21.4793 15.934 21.2736 16.7018 21.6203 17.3023L27.2618 27.0736C27.6085 27.6741 27.4027 28.4419 26.8022 28.7886L23.2649 30.8309C22.6644 31.1776 21.8966 30.9719 21.5499 30.3714L12.6167 14.8986C12.27 14.2981 12.4757 13.5303 13.0762 13.1836L27.9369 4.60376ZM35.6042 36L39 34.0394V36H35.6042Z" fill="#00DC82"/>
</g>
</svg>

After

Width:  |  Height:  |  Size: 4.6 KiB

BIN
docs/static/preview-dark.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

BIN
docs/static/preview.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

19
docs/tailwind.config.js Normal file
View File

@ -0,0 +1,19 @@
module.exports = {
theme: {
extend: {
colors: {
primary: {
100: '#E6FAF2',
200: '#BFF3E0',
300: '#99EBCD',
400: '#4DDCA7',
500: '#00CD81',
600: '#00B974',
700: '#007B4D',
800: '#005C3A',
900: '#003E27'
}
}
}
}
}

File diff suppressed because it is too large Load Diff

View File

@ -7,5 +7,6 @@
[build] [build]
base = "docs" base = "docs"
command = "yarn && yarn build" command = "yarn generate"
publish = "docs/.vuepress/dist" publish = "dist"
ignore = "git diff --quiet HEAD^ HEAD . ../package.json"