Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ddPn08 committed Apr 30, 2023
1 parent 88aaee1 commit 8fb8156
Show file tree
Hide file tree
Showing 32 changed files with 169 additions and 254 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
root = true

[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
indent_style = space

[*.{ts,js,py}]
indent_size = 4
[*.{tsx,jsx,json,yaml,yml}]
indent_size = 2
2 changes: 1 addition & 1 deletion .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
strategy:
fail-fast: false
matrix:
language: ["python", "javascript"]
language: ["python"]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Use only 'java' to analyze code written in Java, Kotlin or both
# Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,10 @@ jobs:
- uses: actions/setup-node@v3
with:
node-version: 16
cache: yarn
- run: yarn install
- run: pnpm install

- name: Build
run: yarn docs:build
run: pnpm docs:build

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
.DS_Store

tmp/
outputs/
config.toml
dist
node_modules/
docs/.vitepress/cache

### Generated by gibo (https://github.com/simonwhitaker/gibo)
### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/VisualStudioCode.gitignore
Expand Down
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
singleQuote: true
semi: false
trailingComma: all
printWidth: 150
139 changes: 64 additions & 75 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,77 +1,66 @@
import { defineConfig } from "vitepress";
import { defineConfig } from 'vitepress'

export default defineConfig({
title: "Lsmith documentation",
description:
"StableDiffusionWebUI using high-speed inference technology with TensorRT",
lang: "en-US",
appearance: "dark",
lastUpdated: true,
base: "/Lsmith/",
themeConfig: {
editLink: {
pattern: "https://github.com/ddPn08/Lsmith/edit/main/docs/:path",
},
socialLinks: [
{
icon: "github",
link: "https://github.com/ddPn08/Lsmith",
},
],
sidebar: [
{
text: "Introduction",
items: [{ text: "Introduction", link: "/" }],
},
{
text: "Installation",
items: [
{ text: "Docker", link: "/installation/docker" },
{ text: "Windows", link: "/installation/windows" },
{ text: "Linux", link: "/installation/linux" },
],
},
{
text: "WebUI",
items: [{ text: "WebUI", link: "/webui/" }],
},
{
text: "API",
items: [{ text: "API", link: "/api/" }],
},
{
text: "Developers",
items: [
{ text: "TensorRT", link: "/developers/tensorrt" },
{
text: "Frontend",
link: "/developers/frontend",
},
{
text: "Documentation",
link: "/developers/documentation",
},
],
},
{
text: "Troubleshooting",
items: [
{ text: "Linux", link: "/troubleshooting/linux" },
{
text: "Windows",
link: "/troubleshooting/windows",
},
{
text: "Docker",
link: "/troubleshooting/docker",
},
],
},
],
algolia: {
appId: "H0ENKDAOQE",
indexName: "lsmith",
apiKey: "292dd349b89a56475ea02a16d4dac69b",
},
},
});
title: 'Radiata documentation',
description: 'StableDiffusionWebUI using high-speed inference technology with TensorRT',
lang: 'en-US',
appearance: 'dark',
lastUpdated: true,
base: '/Radiata/',
themeConfig: {
editLink: {
pattern: 'https://github.com/ddPn08/Radiata/edit/main/docs/:path',
},
socialLinks: [
{
icon: 'github',
link: 'https://github.com/ddPn08/Radiata',
},
],
sidebar: [
{
text: 'Introduction',
items: [{ text: 'Introduction', link: '/' }],
},
{
text: 'Installation',
items: [
{ text: 'Windows', link: '/installation/windows' },
{ text: 'Linux', link: '/installation/linux' },
],
},
{
text: 'WebUI',
items: [
{ text: 'WebUI', link: '/webui/' },
{ text: 'Model', link: '/webui/model' },
],
},
{
text: 'Developers',
items: [
{ text: 'TensorRT', link: '/developers/tensorrt' },
{
text: 'Documentation',
link: '/developers/documentation',
},
],
},
{
text: 'Troubleshooting',
items: [
{ text: 'Linux', link: '/troubleshooting/linux' },
{
text: 'Windows',
link: '/troubleshooting/windows',
},
],
},
],
algolia: {
appId: 'H0ENKDAOQE',
indexName: 'lsmith',
apiKey: '292dd349b89a56475ea02a16d4dac69b',
},
},
})
11 changes: 0 additions & 11 deletions docs/api/index.md

This file was deleted.

11 changes: 5 additions & 6 deletions docs/developers/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Please read the rules before you start editing the documentation.

- All new images will be in WEBP or JPEG format with maximum of 90% image quality
- Images will be of sensible resolution (no 4k or higher resolution images)
- English only
- Grammarly correct when possible
- Keep it simple

Expand All @@ -25,25 +24,25 @@ Once the change is reviewed and approved it will be merged into the branch and w
## Running documentation locally

::: info
`yarn` can be installed using `npm install -g yarn`
`pnpm` can be installed using `npm install -g pnpm`
:::

Clone the repository

```bash
git clone https://github.com/ddPn08/Lsmith.git
git clone https://github.com/ddPn08/Radiata.git
```

Install dependencies

```bash
yarn install
pnpm i
```

Run the documentation

```bash
yarn docs:dev
pnpm docs:dev
```

You should now be able to access the documentation on `http://localhost:5173/Lsmith/`
You should now be able to access the documentation on `http://localhost:5173/Radiata/`
49 changes: 0 additions & 49 deletions docs/developers/frontend.md

This file was deleted.

Binary file removed docs/images/readme-benchmark.png
Binary file not shown.
Binary file removed docs/images/readme-sample-screenshot-01.png
Binary file not shown.
Binary file removed docs/images/readme-sample-screenshot-img2img-01.png
Binary file not shown.
Binary file added docs/images/readme-screenshots-01.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/readme-screenshots-02.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/readme-screenshots-03.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 removed docs/images/readme-usage-screenshot-01.png
Binary file not shown.
Binary file removed docs/images/readme-usage-screenshot-02.png
Binary file not shown.
Binary file added docs/images/webui/model-01.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/webui/model-02.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/webui/model-03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 8 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,24 @@

---

<div align="center"><b>Lsmith is a fast Stable Diffusion WebUI using high-speed inference technology with TensorRT</b></div>
<div align="center"><b>Radiata is a stable diffusion webui based on diffusers.</b></div>

---

# Benchmark

![benchmark](./images/readme-benchmark.png)
# Screenshots

---
- Stable diffusion

# Screenshots
![](./images/readme-screenshots-01.png)

- Batch generation
- Deepfloyd IF

![lemons](./images/readme-sample-screenshot-01.png)
![](./images/readme-screenshots-02.png)

- img2img support
- TensorRT

![img2img](./images/readme-sample-screenshot-img2img-01.png)
![](./images/readme-screenshots-03.png)

---

Expand Down
31 changes: 0 additions & 31 deletions docs/installation/docker.md

This file was deleted.

Loading

0 comments on commit 8fb8156

Please sign in to comment.