Skip to content

Commit c62fcf5

Browse files
authored
docs: improve home page styles
2 parents e534db1 + 45c5c8a commit c62fcf5

File tree

5 files changed

+42
-9
lines changed

5 files changed

+42
-9
lines changed

.github/workflows/release.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ jobs:
6363

6464
- name: DOCS - build
6565
run: npm run build-docs
66+
env:
67+
GH_TOKEN: ${{ secrets.DOC_README_FETCH }}
6668

6769
- name: DOCS - publish
6870
uses: peaceiris/actions-gh-pages@v3

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
1-
# Lesy
1+
# Lesy JS
2+
3+
Lesy js is a flexible lightweight CLI framework to build modern command line apps without too much boilerplate.
4+
5+
If you have already used commander, yargs, gluegun, then lesy js will definitely give you a new experience and you will feel the difference.
6+
7+
### Why LesyJS
8+
9+
- **Language**: Full support for Typescript with @types
10+
11+
- **Boilerplate**: Write less code. whether its a dead simple project or complex one.
12+
13+
- **Flexibility**: Able to change complete behaviour with middlewares
14+
15+
- **Extensions**: Add cool functionalities with plugins
16+
17+
- **Platform**: Write once and run in CLI or UI
18+
19+
- **Performance**: It is just faster than existing libraries. Benchmark inside.
20+
21+
- **Testing**: Dedicated testing setup for unit test and integration test
22+
23+
- **Lot more**: Features, sub commands, existing plugins, Boilerplate generator...
24+
25+
### Try Lesy before installing
26+
27+
We have a setup a _playground_ for you to play around with it.
28+
29+
[![Edit lesy-pilot-playground](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/lesy-pilot-playground-hzjgw?fontsize=14&hidenavigation=1&view=preview)

docs/src/components/parts/footer.js

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,20 @@ const Footer = () => {
3535
return (
3636
<footer className="container mx-auto flex py-16 flex-col lg:flex-row px-10 lg:px-0">
3737
<div className="w-full lg:w-6/12 flex items-center lg:justify-start mb-10 lg:mb-0">
38-
<h3 className="text-gray-400 font-heading font-bold text-2xl">
39-
Lesy CLI Framework
38+
<h3 className="text-gray-400 font-heading font-bold text-2xl flex justify-center">
39+
<div className="bg-gray-400 w-10 h-10 text-center rounded-full inline-flex justify-center items-center mr-3">
40+
<img src="/images/lesy-head.png" class="w-6" alt="lesy icon" />
41+
</div>
42+
<div>Lesy CLI Framework</div>
4043
</h3>
4144
</div>
4245
<div className="w-full lg:w-6/12 flex">
43-
{data.map(d => (
46+
{data.map((d) => (
4447
<div className="w-4/12 lg:text-right">
4548
<h5 className="uppercase text-gray-600 text-sm font-medium">
4649
{d.title}
4750
</h5>
48-
{d.links.map(l => (
51+
{d.links.map((l) => (
4952
<a href={l.link} className="text-gray-500 block">
5053
{l.name}
5154
</a>

docs/src/markdown/docs/main/get-started/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ path: /docs/get-started/overview
44
icon: user-smile-fill
55
---
66

7-
Lesy js is a flexible lighweight CLI framework to build modern command line apps without too much boilerplate.
7+
Lesy js is a flexible lightweight CLI framework to build modern command line apps without too much boilerplate.
88

9-
If you have already used comamnder, yargs, gluegun, then lesy js will definietlry give you a new experince and you will feel the differnce.
9+
If you have already used commander, yargs, gluegun, then lesy js will definitely give you a new experience and you will feel the difference.
1010

1111
### Few things to consider Lesy for your next project
1212

1313
- **Language**: Full support for Typescript with @types
1414
- **Boilerplate**: Write less code. whether its a dead simple project or complex one.
15-
- **Flexibility**: Able to change complete behavior with middlewares
15+
- **Flexibility**: Able to change complete behaviour with middlewares
1616
- **Extensions**: Add cool functionalities with plugins
1717
- **Platform**: Write once and run in CLI or UI
1818
- **Performance**: It is just faster than existing libraries. Benchmark inside.

docs/src/pages/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ const IndexPage = ({ data }) => {
8383
<Example
8484
icon="terminal-window-line"
8585
step="1"
86-
title="Install termo CLI globally"
86+
title="Install lesy CLI globally"
8787
lang="shell"
8888
/>
8989
<Example

0 commit comments

Comments
 (0)