Skip to content

Commit

Permalink
✨ feat: Update demos
Browse files Browse the repository at this point in the history
  • Loading branch information
canisminor1990 committed Sep 18, 2023
1 parent ee3cd5f commit 1515782
Show file tree
Hide file tree
Showing 53 changed files with 297 additions and 384 deletions.
51 changes: 45 additions & 6 deletions .dumirc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,55 @@ const themeConfig = {
match: ['/components'],
pkg: name,
sourceUrl: false,
type: 'doc',
},
description: description,
docStyle: 'pure',
footer: 'Made with 🤯 by LobeHub',
footerConfig: {
resources: {
items: [
{
description: 'Markdown processor ',
openExternal: true,
title: 'Remark',
url: 'https://github.com/remarkjs',
},
{
description: 'Concise badges',
openExternal: true,
title: 'Shields',
url: 'https://shields.io/',
},
{
description: 'Icons for popular brands',
openExternal: true,
title: 'Simple Icons',
url: 'https://simpleicons.org',
},
{
description: 'Dynamically stats for github',
openExternal: true,
title: 'Readme Stats',
url: 'https://github.com/anuraghazra/github-readme-stats',
},
{
description: 'List of GitHub badges',
openExternal: true,
title: 'Awesome Badges',
url: 'https://github.com/Envoy-VC/awesome-badges',
},
],
title: 'Resources',
},
},
giscus: {
category: 'Q&A',
category: 'Ideas',
categoryId: 'DIC_kwDOJloKoM4CXsCu',
repo: 'lobehub/lobe-ui',
repoId: 'R_kgDOJloKoA',
repo: 'lobehub/lobe-readme-wizard',
repoId: 'R_kgDOKTF8TQ',
},
name: 'ReadmeGenerator',
name: 'ReadmeWizard',
nav: [
{ link: '/components/readme-hero', title: 'Generator' },
{ link: 'https://simpleicons.org/', mode: 'override', title: 'Icons' },
Expand All @@ -42,7 +81,7 @@ const themeConfig = {
discord: 'https://discord.gg/AYFPHvv2jT',
github: homepage,
},
title: 'ReadmeGenerator - LobeHub',
title: 'ReadmeWizard - LobeHub',
};

export default defineConfig({
Expand Down Expand Up @@ -75,5 +114,5 @@ export default defineConfig({
}`,
],
themeConfig,
title: 'ReadmeGenerator',
title: 'ReadmeWizard',
});
24 changes: 6 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,62 +2,50 @@

# Changelog

### [Version 0.2.1](https://github.com/lobehub/lobe-readme-generator/compare/v0.2.0...v0.2.1)
<sup>Released on **2023-09-18**</sup>
### [Version 0.2.1](https://github.com/lobehub/lobe-readme-generator/compare/v0.2.0...v0.2.1)

<sup>Released on **2023-09-18**</sup>

#### 🐛 Bug Fixes

- **misc**: Simple icon.


<br/>



<details>
<summary><kbd>Improvements and Fixes</kbd></summary>



#### What's fixed

* **misc**: Simple icon ([0bb612c](https://github.com/lobehub/lobe-readme-generator/commit/0bb612c))
- **misc**: Simple icon ([0bb612c](https://github.com/lobehub/lobe-readme-generator/commit/0bb612c))

</details>


<div align="right">

[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)

</div>

## [Version&nbsp;0.2.0](https://github.com/lobehub/lobe-readme-generator/compare/v0.1.0...v0.2.0)
<sup>Released on **2023-09-17**</sup>
## [Version 0.2.0](https://github.com/lobehub/lobe-readme-generator/compare/v0.1.0...v0.2.0)

<sup>Released on **2023-09-17**</sup>

#### ✨ Features

- **misc**: Add readme generator.


<br/>



<details>
<summary><kbd>Improvements and Fixes</kbd></summary>



#### What's improved

* **misc**: Add readme generator ([aad748d](https://github.com/lobehub/lobe-readme-generator/commit/aad748d))
- **misc**: Add readme generator ([aad748d](https://github.com/lobehub/lobe-readme-generator/commit/aad748d))

</details>


<div align="right">

[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
Expand Down
84 changes: 56 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-logo/1.0.0/files/assets/logo-3d.webp">
<img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg">
<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/memo.webp">
<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji-anim/1.0.0/files/assets/man-mage.webp">

<h1 align="center">Readme Generator</h1>
<h1 align="center">Readme Wizard</h1>

\[WIP] Generate an aesthetically pleasing product README through intelligent methods
Generate lobe style product README _by MAGIC_ \~ 🪄

[Changelog](./CHANGELOG.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]

Expand All @@ -24,7 +24,7 @@
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]

![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268598243-0db9877a-ae3c-4250-8615-7d8b4f695169.png)

</div>

Expand All @@ -33,6 +33,7 @@

#### TOC

- [✨ Features](#-features)
- [⌨️ Local Development](#️-local-development)
- [🤝 Contributing](#-contributing)
- [🔗 More Products](#-more-products)
Expand All @@ -41,6 +42,33 @@

</details>

## ✨ Features

- [x] 📝 **Raedme Generator**
- [x] Hero
- [x] Features
- [x] Installation
- [x] Development
- [x] Contributing
- [x] Credits
- [x] License
- [x] 🔖 **Shields Generator**
- [x] Custom
- [x] Website
- [x] Github
- [x] NPM
- [x] Vercel
- [x] Discord
- [ ] 📦 Generator by `package.json`
- [ ] 🪄 Generator features by openAI
- [ ] ⌨️ CLI tool support

<div align="right">

[![][back-to-top]](#readme-top)

</div>

## ⌨️ Local Development

You can use Github Codespaces for online development:
Expand All @@ -52,7 +80,7 @@ Or clone it for local development:
[![][bun-shield]][bun-link]

```bash
$ git clone https://github.com/lobehub/lobe-readme-generator.git
$ git clone https://github.com/lobehub/lobe-readme-wizard.git
$ cd lobe-chat
$ bun install
$ bun dev
Expand Down Expand Up @@ -104,30 +132,30 @@ This project is [MIT](./LICENSE) licensed.
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square
[bun-link]: https://bun.sh
[bun-shield]: https://img.shields.io/badge/-speedup%20with%20bun-black?logo=bun&style=for-the-badge
[codespaces-link]: https://codespaces.new/lobehub/lobe-readme-generator
[codespaces-link]: https://codespaces.new/lobehub/lobe-readme-wizard
[codespaces-shield]: https://github.com/codespaces/badge.svg
[discord-link]: https://discord.gg/AYFPHvv2jT
[discord-shield]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
[github-action-release-link]: https://github.com/lobehub/lobe-readme-generator/actions/workflows/release.yml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-readme-generator/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/lobehub/lobe-readme-generator/actions/workflows/test.yml
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-readme-generator/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-contrib-link]: https://github.com/lobehub/lobe-readme-generator/graphs/contributors
[github-contrib-shield]: https://contrib.rocks/image?repo=lobehub%2Flobe-readme-generator
[github-contributors-link]: https://github.com/lobehub/lobe-readme-generator/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-readme-generator?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/lobehub/lobe-readme-generator/network/members
[github-forks-shield]: https://img.shields.io/github/forks/lobehub/lobe-readme-generator?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/lobehub/lobe-readme-generator/issues
[github-issues-shield]: https://img.shields.io/github/issues/lobehub/lobe-readme-generator?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/lobehub/lobe-readme-generator/blob/main/LICENSE
[github-license-shield]: https://img.shields.io/github/license/lobehub/lobe-readme-generator?color=white&labelColor=black&style=flat-square
[github-release-link]: https://github.com/lobehub/lobe-readme-generator/releases
[github-release-shield]: https://img.shields.io/github/v/release/lobehub/lobe-readme-generator?logo=github&color=369eff&labelColor=black&style=flat-square
[github-releasedate-link]: https://github.com/lobehub/lobe-readme-generator/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/lobehub/lobe-readme-generator?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/lobehub/lobe-readme-generator/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/lobehub/lobe-readme-generator?color=ffcb47&labelColor=black&style=flat-square
[github-action-release-link]: https://github.com/lobehub/lobe-readme-wizard/actions/workflows/release.yml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-readme-wizard/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/lobehub/lobe-readme-wizard/actions/workflows/test.yml
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-readme-wizard/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-contrib-link]: https://github.com/lobehub/lobe-readme-wizard/graphs/contributors
[github-contrib-shield]: https://contrib.rocks/image?repo=lobehub%2Flobe-readme-wizard
[github-contributors-link]: https://github.com/lobehub/lobe-readme-wizard/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-readme-wizard?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/lobehub/lobe-readme-wizard/network/members
[github-forks-shield]: https://img.shields.io/github/forks/lobehub/lobe-readme-wizard?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/lobehub/lobe-readme-wizard/issues
[github-issues-shield]: https://img.shields.io/github/issues/lobehub/lobe-readme-wizard?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/lobehub/lobe-readme-wizard/blob/main/LICENSE
[github-license-shield]: https://img.shields.io/github/license/lobehub/lobe-readme-wizard?color=white&labelColor=black&style=flat-square
[github-release-link]: https://github.com/lobehub/lobe-readme-wizard/releases
[github-release-shield]: https://img.shields.io/github/v/release/lobehub/lobe-readme-wizard?logo=github&color=369eff&labelColor=black&style=flat-square
[github-releasedate-link]: https://github.com/lobehub/lobe-readme-wizard/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/lobehub/lobe-readme-wizard?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/lobehub/lobe-readme-wizard/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/lobehub/lobe-readme-wizard?color=ffcb47&labelColor=black&style=flat-square
[lobe-chat]: https://github.com/lobehub/lobe-chat
[lobe-commit]: https://github.com/lobehub/lobe-commit/tree/master/packages/lobe-commit
[lobe-i18n]: https://github.com/lobehub/lobe-commit/tree/master/packages/lobe-i18n
Expand All @@ -136,5 +164,5 @@ This project is [MIT](./LICENSE) licensed.
[pr-welcome-link]: https://github.com/lobehub/lobe-chat/pulls
[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
[profile-link]: https://github.com/lobehub
[vecel-link]: https://lobe-readme-generator.vercel.app
[vecel-shield]: https://img.shields.io/website?down_message=offline&label=vecel&labelColor=black&logo=vercel&style=flat-square&up_message=online&url=https%3A%2F%2Flobe-readme-generator.vercel.app
[vecel-link]: https://lobe-readme-wizard.vercel.app
[vecel-shield]: https://img.shields.io/website?down_message=offline&label=vecel&labelColor=black&logo=vercel&style=flat-square&up_message=online&url=https%3A%2F%2Flobe-readme-wizard.vercel.app
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
hero:
title: Readme <b>Generator</b>
description: Generate an aesthetically pleasing product README through intelligent methods
title: Readme <b>Wizard</b>
description: Generate lobe style product README by MAGIC ~ 🪄
---

<code src="./index.tsx" inline></code>
7 changes: 6 additions & 1 deletion docs/index.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import { ReadmeHero } from '@lobehub/readme-generator';
import { Center } from 'react-layout-kit';

export default () => {
return <Center gap={16}></Center>;
return (
<Center gap={16} style={{ marginTop: '-8em', maxWidth: 960 }}>
<ReadmeHero />
</Center>
);
};
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "@lobehub/readme-generator",
"name": "@lobehub/readme-wizard",
"version": "0.2.1",
"description": "Generate an aesthetically pleasing product README through intelligent methods",
"description": "Generate lobe style product README by magic",
"homepage": "https://github.com/lobehub/lobe-readme-generator",
"bugs": {
"url": "https://github.com/lobehub/lobe-readme-generator/issues/new/choose"
"url": "https://github.com/lobehub/lobe-readme-wizard/issues/new/choose"
},
"repository": {
"type": "git",
"url": "https://github.com/lobehub/lobe-readme-generator.git"
"url": "https://github.com/lobehub/lobe-readme-wizard.git"
},
"license": "MIT",
"author": "LobeHub <i@lobehub.com>",
Expand Down
10 changes: 0 additions & 10 deletions src/ReadmeContributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,4 @@ title: Contributing
order: 6
---

## Generator

<br/>

<code src="./index.tsx" inline></code>

<br/>

## Feedback

<br/>
2 changes: 1 addition & 1 deletion src/ReadmeContributing/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { useControls, useCreateStore } from '@lobehub/ui';
import { memo, useMemo } from 'react';

import { defaultControls } from '@/Readme/share';
import MarkdownStorybook from '@/features/MarkdownStorybook';
import MarkdownStorybook from '@/components/MarkdownStorybook';
import { genMarkdownContributing } from '@/services/genMarkdownContributing';

const controls = {
Expand Down
10 changes: 0 additions & 10 deletions src/ReadmeCredits/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,4 @@ title: Credits
order: 6
---

## Generator

<br/>

<code src="./index.tsx" inline></code>

<br/>

## Feedback

<br/>
29 changes: 25 additions & 4 deletions src/ReadmeCredits/index.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,32 @@
import { memo } from 'react';
import { useControls, useCreateStore } from '@lobehub/ui';
import { memo, useMemo, useState } from 'react';

import MarkdownEditor from '@/components/MarkdownEditor';
import MarkdownStorybook from '@/components/MarkdownStorybook';
import { creditsSample } from '@/const/sample';
import MarkdownEditor from '@/features/MarkdownEditor';
import { addBackToTop } from '@/utils/addBackTopTop';
import { genMarkdownCredits } from '@/services/genMarkdownCredits';

const controls = {
/* eslint-disable sort-keys-fix/sort-keys-fix */
title: 'Links',
backToTop: true,
/* eslint-enable */
};

const Credits = memo(() => {
return <MarkdownEditor>{addBackToTop([creditsSample, '']).join('\n\n')}</MarkdownEditor>;
const [value, setValue] = useState(creditsSample);
const store = useCreateStore();

const options = useControls(controls, { store });

const md = useMemo(() => genMarkdownCredits(options, value), [value, options]);

return (
<>
<MarkdownEditor onChange={setValue} value={value} />
<MarkdownStorybook levaStore={store}>{md.join('\n\n')}</MarkdownStorybook>
</>
);
});

export default Credits;
Loading

0 comments on commit 1515782

Please sign in to comment.