Skip to content

Commit 5c0c9cd

Browse files
committed
consolidate dev scripts
1 parent aed2b35 commit 5c0c9cd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+127
-148
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ markdown/markdown
1313
quiki-auth.json
1414
auth.json
1515
test/cache
16+
wiki.log

build

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#!/bin/bash
2+
3+
if [ "$1" == "gendoc" ]; then
4+
for d in */; do
5+
d=${d::${#d}-1}
6+
count=`ls -1 $d/*.go 2>/dev/null | wc -l`
7+
if [ $count != 0 ]; then
8+
godocdown $d > doc/technical/$d.md
9+
fi
10+
done
11+
elif [ "$1" == "help" ]; then
12+
./quiki -wiki=help-wiki -force-gen
13+
cp -r help-wiki resources/adminifier/help
14+
elif [ "$1" == "test" ]; then
15+
./quiki -wiki=test -force-gen
16+
else
17+
echo "Usage: $0 {gendoc|help|test}"
18+
exit 1
19+
fi

doc/technical/wiki.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -568,15 +568,6 @@ func NewWiki(path string) (*Wiki, error)
568568
```
569569
NewWiki creates a Wiki given its directory path.
570570

571-
#### func NewWikiConfig
572-
573-
```go
574-
func NewWikiConfig(confPath string) (*Wiki, error)
575-
```
576-
NewWikiConfig creates a Wiki given the configuration file path.
577-
578-
Deprecated: Use NewWiki instead.
579-
580571
#### func (*Wiki) AbsFilePath
581572

582573
```go
@@ -874,7 +865,7 @@ SortModified.
874865
#### func (*Wiki) Pregenerate
875866

876867
```go
877-
func (w *Wiki) Pregenerate()
868+
func (w *Wiki) Pregenerate() (results []any)
878869
```
879870
Pregenerate simulates requests for all wiki resources such that content caches
880871
can be pregenerated and stored.

doc/technical/wikifier.md

+6
Original file line numberDiff line numberDiff line change
@@ -1023,3 +1023,9 @@ type Warning struct {
10231023
```
10241024

10251025
Warning represents a warning on a page.
1026+
1027+
#### func (Warning) Log
1028+
1029+
```go
1030+
func (w Warning) Log(path string)
1031+
```

gendoc

-8
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"file":"doc/technical/adminifier.cat","name":"doc/technical/adminifier","file_ne":"doc/technical/adminifier","created":"2025-02-23T10:03:07.053046-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.053046-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/adminifier.md","file_ne":"doc/technical/adminifier","created":"2025-02-23T10:17:24.07412648-05:00","modified":"2025-02-23T10:17:24.07412648-05:00","generated":true,"external":true,"fmt_title":"adminifier","title":"adminifier","author":"Markdown","preview":"Contents adminifier Usage func Configure func InitWikis adminifier -- import \".\" Package adminifier provides an administrative panel with a","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[13,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[24,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[35,12]}]}}
1+
{"file":"doc/technical/adminifier.cat","name":"doc/technical/adminifier","file_ne":"doc/technical/adminifier","created":"2025-02-23T10:03:07.053046-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.053046-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/adminifier.md","file_ne":"doc/technical/adminifier","created":"2025-02-23T11:47:36.924161991-05:00","modified":"2025-02-23T11:47:36.924161991-05:00","generated":true,"external":true,"fmt_title":"adminifier","title":"adminifier","author":"Markdown","preview":"Contents adminifier Usage func Configure func InitWikis adminifier -- import \".\" Package adminifier provides an administrative panel with a","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[13,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[24,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[35,12]}]}}
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"file":"doc/technical/authenticator.cat","name":"doc/technical/authenticator","file_ne":"doc/technical/authenticator","created":"2025-02-23T10:03:07.059406-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.059406-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/authenticator.md","file_ne":"doc/technical/authenticator","created":"2025-02-23T10:17:24.09328533-05:00","modified":"2025-02-23T10:17:24.09328533-05:00","generated":true,"external":true,"fmt_title":"authenticator","title":"authenticator","author":"Markdown","preview":"Contents authenticator Usage type Authenticator func Open func (*Authenticator) Login func (*Authenticator) NewUser type User func (*User) GobDecode","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[13,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[24,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[38,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[50,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[61,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[77,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[93,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[104,12]}]}}
1+
{"file":"doc/technical/authenticator.cat","name":"doc/technical/authenticator","file_ne":"doc/technical/authenticator","created":"2025-02-23T10:03:07.059406-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.059406-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/authenticator.md","file_ne":"doc/technical/authenticator","created":"2025-02-23T11:47:36.941019043-05:00","modified":"2025-02-23T11:47:36.941019043-05:00","generated":true,"external":true,"fmt_title":"authenticator","title":"authenticator","author":"Markdown","preview":"Contents authenticator Usage type Authenticator func Open func (*Authenticator) Login func (*Authenticator) NewUser type User func (*User) GobDecode","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[13,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[24,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[38,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[50,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[61,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[77,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[93,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[104,12]}]}}
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"file":"doc/technical/irc.cat","name":"doc/technical/irc","file_ne":"doc/technical/irc","created":"2025-02-23T10:03:07.012584-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.012584-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/irc.md","file_ne":"doc/technical/irc","created":"2025-02-23T10:17:24.113591228-05:00","modified":"2025-02-23T10:17:24.113591228-05:00","generated":true,"external":true,"fmt_title":"irc","title":"irc","author":"Markdown","preview":"irc --"}}
1+
{"file":"doc/technical/irc.cat","name":"doc/technical/irc","file_ne":"doc/technical/irc","created":"2025-02-23T10:03:07.012584-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.012584-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/irc.md","file_ne":"doc/technical/irc","created":"2025-02-23T11:47:36.961919212-05:00","modified":"2025-02-23T11:47:36.961919212-05:00","generated":true,"external":true,"fmt_title":"irc","title":"irc","author":"Markdown","preview":"irc --"}}
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"file":"doc/technical/markdown.cat","name":"doc/technical/markdown","file_ne":"doc/technical/markdown","created":"2025-02-23T10:03:07.211629-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.211629-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/markdown.md","file_ne":"doc/technical/markdown","created":"2025-02-23T10:17:24.131091611-05:00","modified":"2025-02-23T10:17:24.131091611-05:00","generated":true,"external":true,"fmt_title":"markdown","title":"markdown","author":"Markdown","preview":"Contents markdown Usage func Run type QuikiFlags type QuikiRenderer func NewQuikiRenderer func (*QuikiRenderer) RenderFooter func (*QuikiRenderer)","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[13,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[24,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[35,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[43,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[62,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[80,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[92,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[103,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[114,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[136,12]}]}}
1+
{"file":"doc/technical/markdown.cat","name":"doc/technical/markdown","file_ne":"doc/technical/markdown","created":"2025-02-23T10:03:07.211629-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.211629-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/markdown.md","file_ne":"doc/technical/markdown","created":"2025-02-23T11:47:36.977810006-05:00","modified":"2025-02-23T11:47:36.977810006-05:00","generated":true,"external":true,"fmt_title":"markdown","title":"markdown","author":"Markdown","preview":"Contents markdown Usage func Run type QuikiFlags type QuikiRenderer func NewQuikiRenderer func (*QuikiRenderer) RenderFooter func (*QuikiRenderer)","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[13,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[24,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[35,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[43,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[62,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[80,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[92,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[103,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[114,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[136,12]}]}}
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"file":"doc/technical/monitor.cat","name":"doc/technical/monitor","file_ne":"doc/technical/monitor","created":"2025-02-23T10:03:07.218249-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.218249-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/monitor.md","file_ne":"doc/technical/monitor","created":"2025-02-23T10:17:24.146781068-05:00","modified":"2025-02-23T10:17:24.146781068-05:00","generated":true,"external":true,"fmt_title":"monitor","title":"monitor","author":"Markdown","preview":"Contents monitor Usage func WatchWiki monitor -- import \".\" Package monitor provides a file monitor that pre-generates wiki pages and images each","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[13,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[25,12]}]}}
1+
{"file":"doc/technical/monitor.cat","name":"doc/technical/monitor","file_ne":"doc/technical/monitor","created":"2025-02-23T10:03:07.218249-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.218249-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/monitor.md","file_ne":"doc/technical/monitor","created":"2025-02-23T11:47:36.992913628-05:00","modified":"2025-02-23T11:47:36.992913628-05:00","generated":true,"external":true,"fmt_title":"monitor","title":"monitor","author":"Markdown","preview":"Contents monitor Usage func WatchWiki monitor -- import \".\" Package monitor provides a file monitor that pre-generates wiki pages and images each","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[13,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[25,12]}]}}
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"file":"doc/technical/resources.cat","name":"doc/technical/resources","file_ne":"doc/technical/resources","created":"2025-02-23T10:16:24.162253-05:00","created_http":"Sun, 23 Feb 2025 15:16:24 GMT","modified":"2025-02-23T10:16:24.162253-05:00","modified_http":"Sun, 23 Feb 2025 15:16:24 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/resources.md","file_ne":"doc/technical/resources","created":"2025-02-23T10:17:24.161439686-05:00","modified":"2025-02-23T10:17:24.161439686-05:00","generated":true,"external":true,"fmt_title":"resources","title":"resources","author":"Markdown","preview":"Contents resources Usage resources -- import \".\" Usage var Adminifier, _ = fs.Sub(adminifierFS, \"adminifier\") Adminifier provides access to the","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[13,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[18,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[26,12]}]}}
1+
{"file":"doc/technical/resources.cat","name":"doc/technical/resources","file_ne":"doc/technical/resources","created":"2025-02-23T10:16:24.162253-05:00","created_http":"Sun, 23 Feb 2025 15:16:24 GMT","modified":"2025-02-23T10:16:24.162253-05:00","modified_http":"Sun, 23 Feb 2025 15:16:24 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/resources.md","file_ne":"doc/technical/resources","created":"2025-02-23T11:47:37.00839092-05:00","modified":"2025-02-23T11:47:37.00839092-05:00","generated":true,"external":true,"fmt_title":"resources","title":"resources","author":"Markdown","preview":"Contents resources Usage resources -- import \".\" Usage var Adminifier, _ = fs.Sub(adminifierFS, \"adminifier\") Adminifier provides access to the","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[13,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[18,12]},{"message":"No such code{} style 'monokailight' (from config)","position":[26,12]}]}}
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"file":"doc/technical/standalone.cat","name":"doc/technical/standalone","file_ne":"doc/technical/standalone","created":"2025-02-23T10:03:07.22077-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.22077-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/standalone.md","file_ne":"doc/technical/standalone","created":"2025-02-23T10:17:24.177170185-05:00","modified":"2025-02-23T10:17:24.177170185-05:00","generated":true,"external":true,"fmt_title":"standalone","title":"standalone","author":"Markdown","preview":"standalone --"}}
1+
{"file":"doc/technical/standalone.cat","name":"doc/technical/standalone","file_ne":"doc/technical/standalone","created":"2025-02-23T10:03:07.22077-05:00","created_http":"Sun, 23 Feb 2025 15:03:07 GMT","modified":"2025-02-23T10:03:07.22077-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","preserve":true,"type":"page","page_info":{"file":"doc/technical/standalone.md","file_ne":"doc/technical/standalone","created":"2025-02-23T11:47:37.023687209-05:00","modified":"2025-02-23T11:47:37.023687209-05:00","generated":true,"external":true,"fmt_title":"standalone","title":"standalone","author":"Markdown","preview":"standalone --"}}

0 commit comments

Comments
 (0)