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

Compare commits

base: cadence:4eed706ddaf5869ffde8d9a548f0333ed3e3412a
Branches Tags
cadence:main
..
compare: cadence:7f151862b3ceab19b2a3ebba8b77be6bf63afa0d
Branches Tags
cadence:main

No commits in common. "4eed706ddaf5869ffde8d9a548f0333ed3e3412a" and "7f151862b3ceab19b2a3ebba8b77be6bf63afa0d" have entirely different histories.
4eed706dda ... 7f151862b3

1 changed files with 6 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

45
docs.scrbl
View file

@ -32,51 +32,24 @@
(if (string? (third row)) (url (third row)) (third row)))) (if (string? (third row)) (url (third row)) (third row))))
`((,(literal "Hoster") #f ,(literal "Link")) `((,(literal "Hoster") #f ,(literal "Link"))
("Cadence" "https://cadence.moe" "https://breezewiki.com") ("Cadence" "https://cadence.moe" "https://breezewiki.com")
("PussTheCat.org" "https://pussthecat.org" "https://breezewiki.pussthecat.org") ("PussTheCat" "https://pussthecat.org" "https://breezewiki.pussthecat.org")
("Odyssey346" "https://odyssey346.dev/" "https://bw.odyssey346.dev/") ("Odyssey346" "https://odyssey346.dev/" "https://bw.odyssey346.dev/")
("~vern" "https://vern.cc/" "https://bw.vern.cc/") ("~vern" "https://vern.cc/" "https://bw.vern.cc/")
))] ))]
@subsection[#:tag "Tools"]{Tools} @subsection{Tools}
@subsubsection{Cadence's redirector} @subsubsection{Cadence's redirector}
@url{https://docs.breezewiki.com/files/redirector.user.js} @url{https://docs.breezewiki.com/files/redirector.user.js}
Displays a giant banner and you can click a link to go to BreezeWiki. Displays a giant banner with a link to send you to BreezeWiki.
@subsubsection{Barrow's redirector} @subsubsection{barr0w's redirector}
@url{http://alphamethyl.barr0w.net/~barrow/src/barrownet_ca_redirector/breezewiki_redirector.user.js} @url{http://alphamethyl.barr0w.net/~barrow/src/barrownet_ca_redirector/breezewiki_redirector.user.js}
Just sends you to BreezeWiki automatically. Just sends you to BreezeWiki.
@; -----------------------------------------------------------------------------
@section{Automatic Redirection}
If you'd like to be automatically redirected from fandom.com to breezewiki.com, follow @italic{one} of the methods below.
@subsection{Browser extension: Redirector}
This will redirect you with no fanfare.
@itemlist[#:style 'ordered
@item{Install the extension: @hyperlink["https://addons.mozilla.org/en-GB/firefox/addon/redirector/" "Firefox"] or @hyperlink["https://chrome.google.com/webstore/detail/redirector/ocgpenflpmgnfapjedencafcfakcekcd" "Chrome"]}
@item{Download this file: @url{https://docs.breezewiki.com/files/breezewiki-redirector.json}}
@item{Click on the Redirector extension icon, click @italic{Edit Redirects}, click @italic{Import}, then choose the @italic{breezewiki-redirector.json} file you just downloaded. It will say successfully imported.}
@item{Once it's imported, you can delete the @italic{breezewiki-redirector.json} file from your computer.}
]
@subsection{Browser extension: Violentmonkey}
@nested[#:style (style "block-note" null)]{Violentmonkey executes @italic{userscripts} created by other people, which can do many things to your web browser, more than just redirect you. Some may be helpful, some may be harmful. Make sure you only install userscripts that you trust.}
@itemlist[#:style 'ordered
@item{@hyperlink["https://violentmonkey.github.io/get-it/" "Install the extension"] (or you can choose another userscript manager, like Greasemonkey or Tampermonkey)}
@item{Look at the @Secref["Tools"] section of this website, choose somebody's userscript, and click the link.}
@item{Violentmonkey will show you the code of the userscript, and offer to install it for you. If you want to proceed with the installation, click @italic{Confirm Installation}.}
]
@; ----------------------------------------------------------------------------- @; -----------------------------------------------------------------------------
@ -141,12 +114,6 @@ Now you can start BreezeWiki using one of the following methods.
To be able to start up BreezeWiki faster, use @code{raco make dist.rkt} to byte-compile individual files. To be able to start up BreezeWiki faster, use @code{raco make dist.rkt} to byte-compile individual files.
@subsection{Running with Docker}
@nested[#:style (style "block-note" null)]{There is no official Docker support. Information herein is created by members of the community. Using Docker makes it more difficult to debug and find help if you encounter problems.}
Image provided by PussTheCat.org: @url{https://github.com/PussTheCat-org/docker-breezewiki-quay}
@subsection{What next?} @subsection{What next?}
If you're running BreezeWiki in production (i.e. not for development) then check out the @secref["Required options"] section of the configuration page. If you're running BreezeWiki in production (i.e. not for development) then check out the @secref["Required options"] section of the configuration page.
@ -210,5 +177,5 @@ 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 link hrefs to image files, thereby reducing the potential for end-users to connect to Fandom servers.
} }