cadence/breezewiki-docs
2
1
Fork 2
Code Issues Pull requests Releases Activity

Recommend DrRacket; document new settings

Browse source
This commit is contained in:
Cadence Ember 2022-10-04 22:11:55 +13:00
parent 5b9d456f7a
commit 74f7568252
Signed by: cadence
GPG key ID: BC1C2C61CF521B17
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs.scrbl
View file

@ -170,7 +170,9 @@ Here is an example configuration file. It shows all the available settings and a
@verbatim{ @verbatim{
canonical_origin = canonical_origin =
debug = false debug = false
log_outgoing = true
port = 10416 port = 10416
strict_proxy = true
} }
@subsubsection{Format} @subsubsection{Format}
@ -214,17 +216,21 @@ The URL that the homepage of the instance is intended to be accessed at.
For example, @code{https://breezewiki.com} For example, @code{https://breezewiki.com}
} }
@defthing[debug boolean #:value false]{ @defthing[debug boolean #:value "false"]{
Enables debugging mode, for debugging BreezeWiki during development. Enables debugging mode, for debugging BreezeWiki during development.
Enables more runtime checks and more verbose output. Turns off some browser caching. Enables more runtime checks and more verbose output. Turns off some browser caching.
} }
@defthing[log_outgoing boolean #:value "true"]{
Whether to log outgoing requests to Fandom to the console.
}
@defthing[port value #:value "10416"]{ @defthing[port value #:value "10416"]{
Which port to run the server on. Which port to run the server on.
} }
@defthing[strict_proxy boolean #:value true]{ @defthing[strict_proxy boolean #:value "true"]{
Whether to put more URLs through the proxy. If false, just a minimal set is proxied. If true, additionally proxies page stylesheets and links to image files, thereby reducing the potential for end-users to connect to Fandom servers. Whether to put more URLs through the proxy. If false, just a minimal set is proxied. If true, additionally proxies page stylesheets and links to image files, thereby reducing the potential for end-users to connect to Fandom servers.
} }
@ -240,6 +246,8 @@ If you are new to programming entirely, BreezeWiki is likely not a good introduc
If you already know programming concepts but are new to Racket, I recommend reading @hyperlink["https://docs.racket-lang.org/quick/" "Quick: An Introduction to Racket with Pictures"] and trying the instructions for yourself. This should fill you in on the basics of practically using the Racket language. After reading that, if you want to know the fundamentals even more in-depth, you can check out the @hyperlink["https://docs.racket-lang.org/guide/index.html" "Racket Guide"], which is better to jump around in rather than read from start to end. If you already know programming concepts but are new to Racket, I recommend reading @hyperlink["https://docs.racket-lang.org/quick/" "Quick: An Introduction to Racket with Pictures"] and trying the instructions for yourself. This should fill you in on the basics of practically using the Racket language. After reading that, if you want to know the fundamentals even more in-depth, you can check out the @hyperlink["https://docs.racket-lang.org/guide/index.html" "Racket Guide"], which is better to jump around in rather than read from start to end.
I @italic{highly recommend} using the official DrRacket IDE to write Racket code, particularly if you are a beginner. It applies useful indentation automatically and it has extremely good hover hints. Once you are familiar with Racket, you could configure Emacs, VSCode, Vim, or your favourite other editor to understand Racket's style rules, though you might still miss out on the really good hover hints.
@subsection{Files} @subsection{Files}
@code{breezewiki.rkt} and @code{dist.rkt} are entrypoints. They do as little as possible, just requiring the page functions and starting the web server. @code{breezewiki.rkt} and @code{dist.rkt} are entrypoints. They do as little as possible, just requiring the page functions and starting the web server.