m/breezewiki-docs
1
0
Fork 0
forked from cadence/breezewiki-docs
Code Pull requests Activity

Update

Browse source
This commit is contained in:
Cadence Ember 2023-03-05 22:37:26 +13:00
parent 71c9d4eaf4
commit ed81287064
3 changed files with 119 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
custom-style.css
View file

@ -1,5 +1,10 @@
html {
font-size: 18px;
min-height: 100%;
}
html, .main, .refcontent, .tocview, .tocsub, .sroman, i {
font-family: "Source Sans Pro", "Segoe UI", sans-serif;
}
body {
@ -8,6 +13,21 @@ body {
grid-template-columns: auto minmax(auto, 750px);
gap: 20px;
padding-bottom: 10vh;
background: linear-gradient(to bottom, rgba(225, 133, 155, 0) 15%, rgba(225, 133, 155, 0.8)), url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAIAAAD8GO2jAAABhGlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AcxV9TxaIVBzsUcchQnSyKFnHUKhShQqkVWnUwufQLmjQkKS6OgmvBwY/FqoOLs64OroIg+AHi6OSk6CIl/i8ptIjx4Lgf7+497t4BQqPCVLNrAlA1y0gn4mI2tyr2vCKAMPoQw7jETH0ulUrCc3zdw8fXuyjP8j735+hX8iYDfCLxLNMNi3iDeHrT0jnvE4dYSVKIz4nHDLog8SPXZZffOBcdFnhmyMik54lDxGKxg+UOZiVDJY4RRxRVo3wh67LCeYuzWqmx1j35C4N5bWWZ6zSHkcAilpCCCBk1lFGBhSitGikm0rQf9/APOf4UuWRylcHIsYAqVEiOH/wPfndrFqYm3aRgHOh+se2PEaBnF2jWbfv72LabJ4D/GbjS2v5qA5j5JL3e1iJHwMA2cHHd1uQ94HIHCD/pkiE5kp+mUCgA72f0TTlg8BboXXN7a+3j9AHIUFfJG+DgEBgtUva6x7sDnb39e6bV3w/R53LNAMqFwAAAAAZiS0dEAN8A3wDfYl/uvwAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB+YIGAs5OfTAjN0AAAOSelRYdFJhdyBwcm9maWxlIHR5cGUgZXhpZgAASImtV1FyxSYM/NcpegRLQgiOg8HM9AY9fhfs9+IkbpvYhXleLGQhdrGc0PbXn53+QJOFhYJ5ijnGBS3kkKVgkJa95XnlJczrbHJM4f6Tnd4TCLsoUPdbL4d/gd0+HnitwetnO6VjRtIR6Jh4BdSx8litnZOEXXY7hyNQ3vZBzMnPqa5HqvVwnKkcP/V9h68g457OhuBgqRm8VGRT1mVe056Bjp9oASZcRcPwU8XY1GmHIxMQ8ml7L3y1dFjDp7k5oq/sv0dfyJdy2PULl/HgCIPLCbZr8ifFp4X1nZF8nij2CvWd5N5b6n3bd1dCBKNx2U/UQi92xjNwXEG5zsciuuNnGPvsGT0tZakQpy11WdErZxao0okDNy7ceZtYuSLFIJs4UKSKTltSlywVirGG0bmLa9YGBUWrbAT5gso7F57r5rle5YSVG8NVGMF4yv8Pnf5t8jedeq+DIl7SmyvkJePkIo2h3LjCC4JwP3SzSfCrH/J/tCGsQkGbNCdssCzrHmI1/jhbOnVW+BlwfyuYvB0BQBHWNiTDCgWWyGoceXERZwaPCQIVZD7ejRUKsJk0JClBNQq5JBlr4xnn6SsmUYYZtQlCmEZ1aJO1QKwQDOfHQ8IZKqYWzCyaWyLLVqLGEC3G6HEUueLqwc2juyfPXpKmkCzF5CmlnEqWrKiBlmP2nHLOpQgVLFQQq8C/wLLKqmtYbY2rr2nNa6k4PjVUq7F6TTXX0qRpQ5losXlLLbeyMW2oFFvYbIubb2nLW+k4a1176NZj95567uWt2qHqt/4L1fhQTaZSw8/fqsFK7q8QPMqJDc2gmASG4j4UwIGWodmSOAQZyg3NljxqmgmStKENNR6KQcKwsVjnt3Yfyv1IN7L0I93kv5SjId3/oRxBuu+6XajWxneuTsX2t3Bwuijevg1FBucolZ6SNl/KuEUZ/CVKNg7GRiu+HHMIGX+JDEJHOOy5jowwHB/a32GxEctijWlGNRqfxzH4OVqbu1pZ9bRPukXIBR90i5CL/dItQi72TbcIuUC6RcgF0i1CLpBuEXKBdIuQC6RbhFwg3SLkgg+6RcgF0t0HvxJKT2rQmVB6UoPORNGTGnTeLz2pQWekJzXojPSkBp2RntSgM9KTGnRGelKDzkhPatAZ6UkNOiM9qUFnPuhJDTrzQfdrEP5CwX/K9DfFYI6VPUAd9wAAADVJREFUSMdjuLLZmSR0doEjSYhh1IJRC0YtGLVg1IIhYQGpGkh10KgFoxaMWjBqwagFQ8ICAL098FvNiSR9AAAAAElFTkSuQmCC);
}
.navsettop, .navsetbottom, .tocsub, .tocview {
background: #fcfcfc;
border: none;
}
.maincolumn {
background: #fcfcfc;
padding: 0px 2vw;
}
.tocsub, .tocview {
padding: 6px;
}
.tocset, .maincolumn {
@ -15,6 +35,10 @@ body {
margin: 0;
}
.navsettop {
margin-bottom: 1em;
}
.tocviewlist table {
font-size: 1rem;
}
@ -51,7 +75,6 @@ h5 {
font-size: 0.90em;
}
.user-table {
border-collapse: collapse;
}
@ -89,6 +112,16 @@ h5 {
margin: 0;
}
.recommended-tool {
padding: 1px 20px;
margin: 0;
border-radius: 26px;
background: linear-gradient(150deg, #bcfbc2, #fff4c9);
box-shadow: 0px 3px 11px -5px black;
border: 1px #868686 solid;
border-bottom-width: 3px;
}
@media (max-width: 600px) {
body {
grid-template-columns: 1fr;
@ -98,3 +131,40 @@ h5 {
width: auto;
}
}
/* *****
* Custom Font - all of windows' preinstalled fonts are garbage, so I have to add a custom one
* Source Sans Pro © 20100, 2012, 2014 Adobe Systems Incorporated
* font files licensed under the SIL Open Font License version 1.1 http://scripts.sil.org/OFL
* this license notice must be distributed with the font files.
* thanks to https://github.com/majodev/google-webfonts-helper/ for the downloader!
***** */
@font-face {
font-family: "Source Sans Pro";
font-style: normal;
font-weight: 400;
font-display: swap;
src: local("Source Sans Pro"),
url("/files/source-sans-pro-v21-vietnamese_latin-ext_latin_greek-ext_greek_cyrillic-ext_cyrillic-regular.woff2") format("woff2");
}
@font-face {
font-family: "Source Sans Pro";
font-style: italic;
font-weight: 400;
font-display: swap;
src: url("/files/source-sans-pro-v21-vietnamese_latin-ext_latin_greek-ext_greek_cyrillic-ext_cyrillic-italic.woff2") format("woff2");
}
@font-face {
font-family: "Source Sans Pro";
font-style: normal;
font-weight: 700;
font-display: swap;
src: url("/files/source-sans-pro-v21-vietnamese_latin-ext_latin_greek-ext_greek_cyrillic-ext_cyrillic-700.woff2") format("woff2");
}
@font-face {
font-family: "Source Sans Pro";
font-style: italic;
font-weight: 700;
font-display: swap;
src: url("/files/source-sans-pro-v21-vietnamese_latin-ext_latin_greek-ext_greek_cyrillic-ext_cyrillic-700italic.woff2") format("woff2");
}

66
docs.scrbl
View file

@ -25,7 +25,7 @@
("Documentation source" "https://gitdab.com/cadence/breezewiki-docs")
))]
@subsection{Instances}
@subsection{Mirrors}
@tabular[#:style (style "user-table instance-list user-table--title" null)
`((,(literal "Hoster") ,(literal "Link"))
@ -36,21 +36,7 @@
(list (if (string? owner-website) (hyperlink owner-website owner-name) owner-name)
(url instance))))]
Instances JSON data: @url{https://docs.breezewiki.com/files/instances.json}
@subsection[#:tag "Tools"]{Tools}
@subsubsection{Cadence's redirector}
@url{https://docs.breezewiki.com/files/redirector.user.js}
Displays a giant banner and you can click a link to go to BreezeWiki.
@subsubsection{Barrow's redirector}
@url{http://alphamethyl.barr0w.net/~barrow/src/barrownet_ca_redirector/breezewiki_redirector.user.js}
Just sends you to BreezeWiki automatically.
@hyperlink["https://docs.breezewiki.com/files/instances.json" "Machine-readable data"]
@; -----------------------------------------------------------------------------
@ -60,6 +46,19 @@ If you'd like to be automatically redirected from fandom.com to breezewiki.com,
@hyperlink["https://buddyfight.fandom.com/wiki/It_Doesn%27t_Work!!?b=" "Test whether you're currently being redirected!"]
@subsection{Browser extension: Indie Wiki Buddy}
@nested[#:style (style "recommended-tool" null)]{
@bold{This is easiest to use!} It works in Firefox and Chrome on the computer.
@itemlist[#:style 'ordered
@item{Install the extension: @hyperlink["https://addons.mozilla.org/en-US/firefox/addon/indie-wiki-buddy/" "Firefox"] or @hyperlink["https://chrome.google.com/webstore/detail/indie-wiki-buddy/fkagelmloambgokoeokbpihmgpkbgbfm" "Chrome"]}
@item{Click its icon and check "BreezeWiki is on" at the top.}
]
@bold{There you go, all done!} If it works, you can stop reading here.
}
@subsection{Browser extension: Redirector}
This will redirect you with no fanfare. It works in Firefox and Chrome on the computer.
@ -73,13 +72,15 @@ This will redirect you with no fanfare. It works in Firefox and Chrome on the co
@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.}
@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.
Userscripts from this page are known to be trustworthy :)}
Violentmonkey works in all web browsers on the computer.
@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{@hyperlink["http://alphamethyl.barr0w.net/~barrow/src/barrownet_ca_redirector/breezewiki_redirector.user.js" "Install Barrow's userscript"], which will automatically send you to BreezeWiki. Alternatively, @hyperlink["https://docs.breezewiki.com/files/redirector.user.js" "Install Cadence's userscript"], which will show a big banner you can click to take you to BreezeWiki.}
@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}.}
]
@ -102,7 +103,7 @@ There is the @italic{mailing list} which is the first line for people like you t
Please spend one minute @hyperlink["https://todo.sr.ht/~cadence/breezewiki-todo" "checking the todo tracker"] so you don't submit a duplicate of somebody else's report.
For real-time chat with the community, check out @url{https://matrix.to/#/#breezewiki:cadence.moe}.
You can interact with the mailing list and the todo tracker without needing to register any accounts on any websites! It's all done through regular email.
@subsection{Actually sending a report}
@ -118,6 +119,12 @@ Please make sure to include the following information:
Thanks!
@subsection{Other communication channels}
For real-time chat with the community, @hyperlink["https://matrix.to/#/#breezewiki:cadence.moe" "check out our chatroom!"]
To privately contact Cadence, the developer of BreezeWiki, @hyperlink["https://cadence.moe/contact" "here's their website with contact info."] If you run a wiki on Fandom or any other website, you're very welcome to send me a message! If you don't run any wikis, you're a normal amount of welcome :D
@; -----------------------------------------------------------------------------
@section{Running}
@ -141,10 +148,11 @@ This method is recommended for people who want to edit the source code, or for p
@itemlist[#:style 'ordered
@item{Install Racket. Please install the latest version. 8.4 or later is required.}
@item{Clone the repository from @url{https://gitdab.com/cadence/breezewiki}.}
@item{Run @code{raco pkg install --auto --skip-installed} in the repository to install dependencies.}
@item{Run @code{raco pkg install --auto req} to install the @code{raco req} command.}
@item{Run @code{raco req -d} in the repository to install dependencies.}
]
@nested[#:style (style "block-note" null)]{If building in an automated environment, like CI, use the flags @code{--batch --auto --no-docs --skip-installed}.}
@nested[#:style (style "block-note" null)]{If building in an automated environment, like CI, instead use @code{raco pkg install --batch --auto --no-docs --skip-installed req}.}
Now you can start BreezeWiki using one of the following methods.
@ -161,6 +169,14 @@ To be able to start up BreezeWiki faster, use @code{raco make dist.rkt} to byte-
Image provided by PussTheCat.org: @url{https://github.com/PussTheCat-org/docker-breezewiki-quay}
@subsection{Resource usage}
A full clone of BreezeWiki uses less than 10 MB of space on disk.
RAM usage is typically 400-500 MB.
CPU usage is difficult to specify, and depends on how frequently it sees incoming requests. When not servicing requests, it shouldn't be using any processing power.
@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.
@ -169,13 +185,15 @@ If you're running BreezeWiki in production (i.e. not for development) then check
@section[#:tag "Configuration"]{Configuration}
Please set up your configuration file. You must restart BreezeWiki for it to take effect.
@subsection{File}
Configuration options are added to the @code{config.ini} file. It is a regular INI file.
Configuration options are added to the @code{config.ini} file. It is a regular INI file. When running from source, @code{config.ini} goes next to @code{breezewiki.rkt} in the root directory of the repo.
If you do not specify a specific option, the internal default will be used. If the file is missing or empty, all defaults will be used.
If you're using a compiled distribution of BreezeWiki, the main @code{config.ini} file will actually be a symlink to the real location of the file. Make sure not to erase the symlink, or your settings will be ignored!
When running a compiled distribution of BreezeWiki, the main @code{config.ini} file will actually be a symlink to the real location of the file. Make sure not to erase the symlink, or your settings will be ignored!
@subsubsection{Example}
@ -225,7 +243,7 @@ When running in production, @code{canonical_origin} is highly recommended.
@subsection{Detailed Options}
@defthing[canonical_origin value #:value ""]{
The URL that the homepage of the instance is intended to be accessed at.
The primary URL where people can access the homepage of your instance.
For example, @code{https://breezewiki.com}
}

10
files/instances.json
View file

@ -1,8 +1,10 @@
[
{"owner_name": "Cadence", "owner_website": "https://cadence.moe", "instance": "https://breezewiki.com"},
{"owner_name": "Artemis Everfree", "owner_website": "https://artemis.sh/", "instance": "https://antifandom.com"},
{"owner_name": "PussTheCat.org", "owner_website": "https://pussthecat.org", "instance": "https://breezewiki.pussthecat.org"},
{"owner_name": "Odyssey346", "owner_website": "https://odyssey346.dev", "instance": "https://bw.odyssey346.dev"},
{"owner_name": "~vern", "owner_website": "https://vern.cc", "instance": "https://bw.vern.cc"},
{"owner_name": "Esmail", "owner_website": "https://en.esmailelbob.xyz", "instance": "https://breezewiki.esmailelbob.xyz"},
{"owner_name": "Artemis", "owner_website": "https://artemislena.eu", "instance": "https://bw.artemislena.eu"}
{"owner_name": "Project Segfault", "owner_website": "https://projectsegfau.lt", "instance": "https://bw.projectsegfau.lt"},
{"owner_name": "Hostux", "owner_website": "https://hostux.network", "instance": "https://breeze.hostux.net"},
{"owner_name": "Artemis Lena", "owner_website": "https://artemislena.eu", "instance": "https://bw.artemislena.eu"},
{"owner_name": "Jae", "owner_website": "https://777.tf", "instance": "https://breeze.777.tf/"},
{"owner_name": "Esmail", "owner_website": "https://en.esmailelbob.xyz", "instance": "https://breezewiki.esmailelbob.xyz"}
]