Skip to content

Commit

Permalink
📝 more css stuff and start work on metadata docs
Browse files Browse the repository at this point in the history
  • Loading branch information
asoji committed Aug 8, 2024
1 parent fe06fa9 commit 2dd0b0f
Show file tree
Hide file tree
Showing 7 changed files with 120 additions and 21 deletions.
47 changes: 40 additions & 7 deletions Writerside/cfg/static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,40 @@
:root {
--app-header: var(--wh-color-bg-main);
--app-footer: var(--wh-color-bg-main);
--section-background-color-alpha: 0.10;
--primary-color-75: rgba(247, 93, 98, 0.75);
--primary-color-50: rgba(247, 93, 98, 0.5);
--primary-color-25: rgba(247, 93, 98, 0.25);
--primary-color-10: rgba(247, 93, 98, 0.1);
--primary-color-5: rgba(247, 93, 98, 0.05);
--actual-primary-color: 247, 93, 98;
--75-alpha: 0.75;
--50-alpha: 0.5;
--25-alpha: 0.25;
--10-alpha: 0.1;
--5-alpha: 0.05;

--primary-color-75: rgba(var(--actual-primary-color), var(--75-alpha));
--primary-color-50: rgba(var(--actual-primary-color), var(--50-alpha));
--primary-color-25: rgba(var(--actual-primary-color), var(--25-alpha));
--primary-color-10: rgba(var(--actual-primary-color), var(--10-alpha));
--primary-color-5: rgba(var(--actual-primary-color), var(--5-alpha));
}

/* ===== Scrollbar CSS ===== */
/* Firefox */
* {
scrollbar-width: auto;
scrollbar-color: var(--actual-primary-color) #ffffff;
}

/* Chrome, Edge, and Safari */
*::-webkit-scrollbar {
width: 0.5em;
}

*::-webkit-scrollbar-track {
background: #ffffff;
}

*::-webkit-scrollbar-thumb {
background-color: rgb(var(--actual-primary-color));
border-radius: 0.5em;
border: 1px transparent;
}

/* starting page card */
Expand Down Expand Up @@ -177,7 +205,12 @@
}

/* selected/hovered in ToC */
.toc-item--selected, .toc-item--highlighted {
.toc-item--selected {
border-top-right-radius: 0.5em;
border-bottom-right-radius: 0.5em;
}

.toc-item--highlighted:first-child:last-child {
border-top-right-radius: 0.5em;
border-bottom-right-radius: 0.5em;
}
Expand Down
7 changes: 5 additions & 2 deletions Writerside/docs.tree
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@
<toc-element topic="Yiski6-Commands.md"/>
</toc-element>
<toc-element topic="Runner.topic" toc-title="Runner"></toc-element>
<toc-element topic="Modules.topic" toc-title="Modules"></toc-element>
<toc-element topic="Modules-Loader.topic" toc-title="Modules Loader"></toc-element>
<toc-element topic="Modules-Loader.topic" toc-title="Modules Loader">
</toc-element>
<toc-element topic="Modules.md">
<toc-element topic="Modules-Metadata.md"/>
</toc-element>
<toc-element toc-title="GitHub Repo" href="https://github.com/devOS-Sanity-Edition/Yiski"></toc-element>
</instance-profile>
12 changes: 0 additions & 12 deletions Writerside/redirection-rules.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,4 @@
<accepts>page.html</accepts>
</rule>
-->
<rule id="7c0e0e95">
<description>Created after removal of "Section Starting Page" from Yiski</description>
<accepts>Section-Starting-Page.html</accepts>
</rule>
<rule id="2111a8d">
<description>Created after removal of "How to" from Yiski</description>
<accepts>How-to.html</accepts>
</rule>
<rule id="207e4837">
<description>Created after removal of "Reference" from Yiski</description>
<accepts>Reference.html</accepts>
</rule>
</rules>
23 changes: 23 additions & 0 deletions Writerside/snippets/yiski.metadata.example.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[metadata]
version = 0

[runner]
mainClass = ""

[module]
configClass = ""

[module.packages]
databasePackage = ""
slashCommandsPackage = ""

[information]
id = ""
name = ""
description = ""
version = "${version}"
repo = ""
license = ""
authors = [
""
]
24 changes: 24 additions & 0 deletions Writerside/snippets/yiski.metadata.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[metadata]
version = 0

[runner]
mainClass = "one.devos.yiski1.Yiski1"

[module]
configClass = "one.devos.yiski1.Yiski1Config"

[module.packages]
databasePackage = "one.devos.yiski1.tables"
slashCommandsPackage = "one.devos.yiski1.commands"

[information]
id = "yiski1"
name = "Yiski1"
description = "Basic commands and moderation [kick/ban/timeout/logging/etc]"
version = "${version}"
repo = "https://github.com/devOS-Sanity-Edition/yiski/"
license = "MIT"
authors = [
"asojidev",
"CephalonCosmic"
]
27 changes: 27 additions & 0 deletions Writerside/topics/Modules-Metadata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Modules Metadata

> Work in Progress
{style="warning"}

Every module needs its own Metadata file, a file that contains information about what to load.
Specifically, it tells the Runner to run the module's respective config, PostgresQL tables, slash commands, and
information about itself.

<tabs>
<tab title="Empty">
<p>yiski.metadata.toml</p>
<br/>
<code-block lang="ini" src="yiski.metadata.example.toml"/>
</tab>
<tab title="Filled">
<p>yiski.metadata.toml</p>
<br/>
<code-block lang="ini" src="yiski.metadata.toml"/>
</tab>
</tabs>



<seealso>
<!--Provide links to related how-to guides, overviews, and tutorials.-->
</seealso>
1 change: 1 addition & 0 deletions Writerside/writerside.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<instance src="docs.tree"/>
<snippets src="snippets"/>
</ihp>

0 comments on commit 2dd0b0f

Please sign in to comment.