mirror of
https://github.com/sbrl/Pepperminty-Wiki.git
synced 2024-11-21 16:13:00 +00:00
Use nightdocs instead of docpress.
I'm fed up with dealing with all the security warning notifications....
This commit is contained in:
parent
7f19a2e929
commit
90c486894f
GPG key ID:
1BE5172E637709C2
7 changed files with 173 additions and 7047 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -1,5 +1,6 @@
|
|||
build.*/
|
||||
_docpress/
|
||||
__nightdocs/
|
||||
build/
|
||||
!build/index.php
|
||||
|
||||
|
|
|
|||
9
build.sh
9
build.sh
|
|
@ -108,13 +108,16 @@ function task_docs {
|
|||
task_end $?;
|
||||
|
||||
task_begin "Building Main Documentation";
|
||||
node_modules/docpress/bin/docpress build;
|
||||
node_modules/.bin/nightdocs -c nightdocs.toml
|
||||
task_end $?;
|
||||
}
|
||||
|
||||
function task_docs-livereload {
|
||||
task_begin "Starting Livereload Documentation Server";
|
||||
node_modules/docpress/bin/docpress serve;
|
||||
task_begin "Listening for changes to docs";
|
||||
while :; do
|
||||
inotifywait -qr -e modify --format '%:e %f' ./docs/ nightdocs.toml;
|
||||
node_modules/.bin/nightdocs -c nightdocs.toml;
|
||||
done
|
||||
task_end $?;
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Documentation
|
||||
# Pepperminty Wiki Docs
|
||||
|
||||
* [Pepperminty Wiki](01-Welcome.md)
|
||||
* [Features](02-Features.md)
|
||||
|
|
@ -6,11 +6,11 @@
|
|||
* [Demo](https://starbeamrainbowlabs.com/labs/peppermint/build/)
|
||||
* [Getting Started](04-Getting-Started.md)
|
||||
* [Getting a Copy](05-Getting-A-Copy.md)
|
||||
* Configuration
|
||||
* **Configuration**
|
||||
* [Configuring your instance](06-Configuration.md)
|
||||
* [Inter-wiki links](06.5-Interwiki-Links.md)
|
||||
* [Writing Modules](07-Writing-Modules.md)
|
||||
* References
|
||||
* **References**
|
||||
* [Configuration Settings](https://starbeamrainbowlabs.com/labs/peppermint/peppermint-config-info.php)
|
||||
* [HTTP API](https://starbeamrainbowlabs.com/labs/peppermint/docs/RestApi/)
|
||||
* [PHP Module API](https://starbeamrainbowlabs.com/labs/peppermint/docs/ModuleApi/)
|
||||
|
|
|
|||
163
docs/theme.css
163
docs/theme.css
|
|
@ -1,74 +1,153 @@
|
|||
:root {
|
||||
--primary-colour: #ff1b1b;
|
||||
--primary-colour-soft: hsla(0, 93%, 68%, 0.58);
|
||||
}
|
||||
|
||||
.body {
|
||||
--background-colour-a: hsla(3, 100%, 70%, 0.3);
|
||||
--background-colour-b: hsla(3, 100%, 80%, 0.3);
|
||||
--background-colour-light: hsla(0, 100%, 100%, 0.5);
|
||||
--background-size: 5em;
|
||||
}
|
||||
|
||||
html, body { font-size: 100%; }
|
||||
body {
|
||||
display: grid;
|
||||
grid-template-columns: minmax(25%, 15em) auto;
|
||||
grid-template-rows: auto auto;
|
||||
grid-template-areas: "navigation content"
|
||||
"navigation footer";
|
||||
|
||||
margin: 0; padding: 0;
|
||||
|
||||
font-family: sans-serif;
|
||||
|
||||
background: repeating-linear-gradient(-55deg,
|
||||
var(--background-colour-a), var(--background-colour-a) var(--background-size),
|
||||
var(--background-colour-b) var(--background-size), var(--background-colour-b) calc(var(--background-size) * 2));
|
||||
}
|
||||
|
||||
.menu {
|
||||
background-color: hsla(0, 100%, 100%, 0.5);
|
||||
}
|
||||
/* Title */
|
||||
.toc-menu .-level-1:first-child {
|
||||
background: url(https://sbrl.github.io/Pepperminty-Wiki/logo.svg) no-repeat top center/10em;
|
||||
margin-top: 0;
|
||||
padding-top: 10em;
|
||||
font-weight: bolder;
|
||||
font-size: 1.25em;
|
||||
text-align: center;
|
||||
main {
|
||||
grid-area: content; min-height: 75vh;
|
||||
padding: 0.5em 10% 0.5em 10%;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
/* Blockquote */
|
||||
.markdown-body blockquote {
|
||||
blockquote {
|
||||
border-left: 0.25em solid var(--primary-colour-soft);
|
||||
}
|
||||
|
||||
/* Bottom menu thingy */
|
||||
.-menu-visible .menu-toggle, .menu-toggle {
|
||||
background: linear-gradient(to bottom, transparent, white);
|
||||
}
|
||||
|
||||
.toc-menu .link.-active, .toc-menu .hlink.-active {
|
||||
box-shadow: inset -0.25em 0 var(--primary-colour);
|
||||
margin-left: 1em; padding-left: 0.5em;
|
||||
}
|
||||
|
||||
/* Headings */
|
||||
.markdown-body h1 {
|
||||
h1 {
|
||||
padding-bottom: 0.25em;
|
||||
border-bottom: 0.1em solid var(--primary-colour);
|
||||
text-align: center;
|
||||
}
|
||||
.markdown-body h2 {
|
||||
h2 {
|
||||
padding-bottom: 0.1em;
|
||||
border-bottom: 0.08em solid var(--primary-colour);
|
||||
}
|
||||
|
||||
/* Code Blocks */
|
||||
.markdown-body pre {
|
||||
border: 0.1em dashed var(--primary-colour-soft);
|
||||
background: hsla(0, 100%, 100%, 0.5);
|
||||
}
|
||||
.markdown-body > :not(pre) code {
|
||||
background: hsla(0, 100%, 100%, 0.7);
|
||||
/* Inline elements */
|
||||
.logo-small {
|
||||
max-width: 1.25em; max-height: 1.25em;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
/* Page Footer */
|
||||
.footer-nav {
|
||||
border: 0;
|
||||
background: linear-gradient(to bottom, transparent, white);
|
||||
|
||||
/* Responsive media */
|
||||
audio, video, img { max-width: 100%; }
|
||||
|
||||
|
||||
/* Code Blocks */
|
||||
pre {
|
||||
padding: 0.25em;
|
||||
|
||||
background: hsla(0, 100%, 100%, 0.5);
|
||||
border: 0.1em dashed var(--primary-colour-soft);
|
||||
|
||||
white-space: pre-wrap;
|
||||
overflow-wrap: anywhere;
|
||||
}
|
||||
.footer-nav.-expanded {
|
||||
border: 0;
|
||||
background: none;
|
||||
pre, :not(pre) > code {
|
||||
background: hsla(0, 100%, 100%, 0.6);
|
||||
border-radius: 0.25em;
|
||||
}
|
||||
.footer-nav.-expanded::before {
|
||||
transition: all 0.25s;
|
||||
background: var(--primary-colour-soft);
|
||||
|
||||
|
||||
/*
|
||||
███ ██ █████ ██ ██ ██ ██████ ████████ ██ ██████ ███ ██
|
||||
████ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ████ ██
|
||||
██ ██ ██ ███████ ██ ██ ██ ██ ███ ██ ██ ██ ██ ██ ██ ██
|
||||
██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||||
██ ████ ██ ██ ████ ██ ██████ ██ ██ ██████ ██ ████
|
||||
*/
|
||||
|
||||
nav {
|
||||
grid-area: navigation;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
|
||||
padding: 0.5em;
|
||||
background-color: var(--background-colour-light);
|
||||
}
|
||||
|
||||
.logo {
|
||||
align-self: center;
|
||||
text-align: center;
|
||||
max-width: 90%; height: 10em;
|
||||
box-sizing: border-box;
|
||||
|
||||
padding: 0 0.5em 0.5em 0.5em;
|
||||
|
||||
}
|
||||
/* nav h1 { margin-top: 0; } */
|
||||
nav ul {
|
||||
list-style-type: none;
|
||||
margin: 0 1.25em; padding: 0;
|
||||
}
|
||||
nav ul li {
|
||||
padding: 0.25em 0;
|
||||
}
|
||||
a, a:visited {
|
||||
color: hsla(5, 87%, 53%, 0.8);
|
||||
transition: color 0.25s;
|
||||
}
|
||||
a:hover { color: hsla(5, 87%, 53%, 0.9); }
|
||||
a:active { color: hsl(5, 87%, 53%); }
|
||||
|
||||
|
||||
/*
|
||||
███████ ██████ ██████ ████████ ███████ ██████
|
||||
██ ██ ██ ██ ██ ██ ██ ██ ██
|
||||
█████ ██ ██ ██ ██ ██ █████ ██████
|
||||
██ ██ ██ ██ ██ ██ ██ ██ ██
|
||||
██ ██████ ██████ ██ ███████ ██ ██
|
||||
*/
|
||||
|
||||
footer {
|
||||
grid-area: footer;
|
||||
margin: 1em 1em 0.5em 1em;
|
||||
/* border: 0; */
|
||||
border-top: 0.25em solid var(--background-colour-light);
|
||||
/* background: linear-gradient(to bottom, transparent, white); */
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
███ ███ ██████ ██████ ██ ██ ███████
|
||||
████ ████ ██ ██ ██ ██ ██ ██ ██
|
||||
██ ████ ██ ██ ██ ██████ ██ ██ █████
|
||||
██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||||
██ ██ ██████ ██████ ██ ███████ ███████
|
||||
*/
|
||||
|
||||
@media (max-width: 500px) {
|
||||
body {
|
||||
grid-template-columns: auto;
|
||||
grid-template-rows: auto auto auto;
|
||||
grid-template-areas: "navigation"
|
||||
"content"
|
||||
"footer";
|
||||
}
|
||||
}
|
||||
|
|
|
|||
10
nightdocs.toml
Normal file
10
nightdocs.toml
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
[template]
|
||||
project_name = "Pepperminty Wiki"
|
||||
logo_src = "https://sbrl.github.io/Pepperminty-Wiki/logo.svg"
|
||||
|
||||
[directories]
|
||||
docs = "./docs"
|
||||
output = "./__nightdocs"
|
||||
|
||||
[theme]
|
||||
file = "./docs/theme.css"
|
||||
7027
package-lock.json
generated
7027
package-lock.json
generated
File diff suppressed because it is too large
Load diff
|
|
@ -21,7 +21,7 @@
|
|||
"homepage": "https://github.com/sbrl/Pepperminty-Wiki#readme",
|
||||
"devDependencies": {
|
||||
"apidoc": "^0.17.7",
|
||||
"docpress": "^0.7.6"
|
||||
"nightdocs": "^1.0.5"
|
||||
},
|
||||
"docpress": {
|
||||
"github": "sbrl/Pepperminty-Wiki",
|
||||
|
|
|
|||
Loading…
Reference in a new issue