Skip to content

Commit 9920a08

Browse files
authored
Update webface-guide.md
1 parent a00ffcc commit 9920a08

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

src/content/docs/development/webface-guide.md

+21-15
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ what else can I add that I do not know about? `??idontknow??`
3131
## Here we go
3232

3333

34-
### - webui (also legacy-webui)
34+
### webui (also legacy-webui)
3535

3636
[webui repo](https://github.com/OpenIPC/webui) (now in frozen state, bug fixes only!)
3737

@@ -43,7 +43,8 @@ Also, the bulk of plugins have been developed in this interface, which many user
4343

4444

4545

46-
### - majestic-webui
46+
### majestic-webui
47+
4748
[majestic-webui repo](https://github.com/OpenIPC/majestic-webui/)
4849

4950
Majestic WebUI was initially created to address some of the issues of the original (now legacy) webui:
@@ -55,12 +56,12 @@ The general structure is mostly oriented at the original design, but slimmed dow
5556
Concerns are mostly brought up if a dev brings in a lot of changes without further support from their side.
5657
But if further maintenance is planned, then I see no reason against some refactoring/updating.
5758

58-
##### * Road Map
59+
#### Road Map
5960
- [ ] filling out the developer's guide
6061
- [ ] Teleport plugins (not just copy, a full refactoring with use of best practicies!) from legacy webui
6162
- [ ] `??idontknow??`
6263

63-
##### * Directory structure
64+
#### Directory structure
6465

6566
| path | description |
6667
|---|---|
@@ -71,49 +72,54 @@ But if further maintenance is planned, then I see no reason against some refacto
7172
| www/cgi-bin/p/ | header, footer |
7273
| www/cgi-bin/p/common.cgi | functions, common used in other scripts |
7374

74-
##### * Code conventions
75+
#### * Code conventions
7576
`??idontknow??`
7677

77-
##### * Best practicies
78+
#### * Best practicies
7879
`??idontknow??`
7980

80-
##### * Some tricks
81+
#### * Some tricks
8182
`??idontknow??`
8283

83-
##### * Template scripts (for a quick and proper start)
84+
#### * Template scripts (for a quick and proper start)
8485
`??idontknow??`
8586

8687

8788

8889
### fancyweb and fancyweb-ng
8990
[fancyweb repo](https://github.com/openipc/fancyweb/) ,
90-
[fancyweb-ng repo](https://github.com/openipc/fancyweb-ng/)
9191

9292
Usefull links: [Preact](https://preactjs.com/) , [Tailwind CSS](https://tailwindcss.com/).
9393

9494
**fancyweb:** a gorgeous interface that did not find its embodiment simply because of some "fatness" at that time and the lack of API work in the streamer. Written in ReactJS.
9595
[An excellent presentation](https://github.com/OpenIPC/fancyweb/blob/master/presentation/OpenIPC_fancyweb_interface_rus.pdf) is available to familiarize yourself with the possibilities.
9696

97-
**fancyweb-ng:** The main idea is to use modern techniques as Preact (not React but Preact) library and tailwind for styling. My (@LaikaPanda) goal is to create the maximum number of simple components that can be used in both. Regarding this choice, then Preact is small and quick and everybody knows it to maintain, and tailwind besides convenient approach significantly reduces the amount of code.
9897

9998

99+
### fancyweb-ng
100+
101+
[fancyweb-ng repo](https://github.com/openipc/fancyweb-ng/)
102+
103+
**fancyweb-ng:** The main idea is to use modern techniques as Preact (not React but Preact) library and tailwind for styling. My (@LaikaPanda) goal is to create the maximum number of simple components that can be used in both. Regarding this choice, then Preact is small and quick and everybody knows it to maintain, and tailwind besides convenient approach significantly reduces the amount of code.
100104

101-
##### * Road Map
105+
106+
#### Road Map
102107
- [ ] filling out the developer's guide
103108

104-
##### * Directory structure
109+
#### Directory structure
105110
| path | description |
106111
|---|---|
107112
| | |
108113

109-
##### * Code conventions
114+
#### Code conventions
110115
`??idontknow??`
111116

112117
##### * Best practicies
113118
`??idontknow??`
114119

115-
##### * Some tricks
120+
#### Some tricks
116121
`??idontknow??`
117122

118-
##### * Template scripts (for a quick and proper start)
123+
#### Template scripts (for a quick and proper start)
119124
`??idontknow??`
125+

0 commit comments

Comments
 (0)