Skip to content

Commit 597aa12

Browse files
authored
JeLuF patch 1 (#1)
* Delete index.html * Create README.md * Update README.md
1 parent ac9e9d0 commit 597aa12

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# stable-diffusion-ui.github.io
2+
3+
This repo contains the documentation for Stable Diffusion UI.
4+
The source code for Stable Diffusion UI is in [the repo cmdr2/stable-diffusion-ui](https://github.com/cmdr2/stable-diffusion-ui).
5+
6+
The documentation can be found in the gh-pages branch in the docs folder. It is using Jekyll as templating engine and github actions to automatically push the
7+
content to the web page.
8+
# Important files
9+
- **_config.yml** Central Jekyll configuration file
10+
- **index.html** Landing page of the website. This file only contains the content block, the layout gets added by Jekyll.
11+
- **media/** and **assets/img/** contain images for the content or for the layout respectively
12+
- **_sass/bootswatch/custom** contains the source files for the CSS stylesheets
13+
- **_docs** contains all documentation articles. To add a new documentation, first create a file `abc.md` in this folder, and then go to:
14+
- **_data/docs.yaml** and add the file name (`abc`) to the section that this document belongs to.
15+
- **_docs/index.md** This file is not listed in _data/docs.yaml but is reachable from the navigation bar.
16+
17+
# Github actions
18+
In `Settings -> Pages`, github actions is configured to publish the page from the branch and the subfolder.

index.html

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)