1
0
mirror of https://github.com/garraflavatra/alphabets.git synced 2025-07-18 01:14:06 +00:00

Upgrade documentation site

This commit is contained in:
2021-05-24 18:05:14 +02:00
parent ed42e0c00b
commit 3d2e84a7fb
10 changed files with 176 additions and 125 deletions

17
docs/usage/advanced.md Normal file
View File

@ -0,0 +1,17 @@
---
title: Advanced usage
---
## Alphabet as a string
```js
alphabet.join('')[0];
//=> 'abcdefghijklmnopqrstuvwxyz'
```
## Uppercase
```js
alphabet.toUpperCase();
//=> ["Α", "Β", "Γ", "Δ", "Ε", "Ζ", "Η", "Θ", "Ι", "Κ", "Λ", "Μ", "Ν", "Ξ", "Ο", "Π", "Ρ", "Σ", "Τ", "Υ", "Φ", "Χ", "Ψ", "Ω"]
```

View File

@ -0,0 +1,21 @@
---
title: Installation
---
## npm
```bash
npm install alphabets --save
```
## Yarn
```bash
yarn add alphabets
```
## CDN
```html
<script src="https://unpkg.com/alphabet@1/dist/bundle.js"></script>
```

18
docs/usage/usage.md Normal file
View File

@ -0,0 +1,18 @@
---
title: Usage
toc: false
---
```js
import { <alphabetYouWantToUse> } from 'alphabets';
```
or:
```js
const alphabets = require('alphabets');
console.log(alphabets.<alphabetYouWantToUse>);
```
where `<alphabetYouWantToUse>` is an alphabet this package supports.
[Here](/api/supported-alphabets) is a list from which you can choose.