Some minor stylistic improvements on docs generation

- [x] Show links to prelude, builtins and stdlib
  - [x] Remove project 'owner' in the header (only show repository)
  - [x] Fix type annotation overflow on mobile
  - [x] Remove the prewrap mode on mobile
This commit is contained in:
KtorZ 2023-04-20 16:28:57 +02:00
parent 4269cf20b0
commit 6b1ed427e7
No known key found for this signature in database
GPG Key ID: 33173CB6F77F4277
3 changed files with 38 additions and 9 deletions

View File

@ -192,7 +192,7 @@ fn generate_module(
documentation: render_markdown(&module.ast.docs.iter().join("\n")),
modules_prefix: modules_prefix.to_string(),
modules,
project_name: &config.name.to_string(),
project_name: &config.name.repo.to_string(),
page_title: &format!("{} - {}", module.name, config.name),
module_name: module.name.clone(),
project_version: &config.version.to_string(),
@ -285,7 +285,7 @@ fn generate_readme(
breadcrumbs: ".",
modules_prefix: modules_prefix.to_string(),
modules,
project_name: &config.name.to_string(),
project_name: &config.name.repo.to_string(),
page_title: &config.name.to_string(),
project_version: &config.version.to_string(),
content: render_markdown(&content),

View File

@ -166,6 +166,11 @@
<svg class="label icon icon-x-circle" alt="Open Search" title="Open Search"><use xlink:href="#icon-svg-search"></use></svg>
</button>
<nav>
<a href="https://aiken-lang.github.io/prelude/aiken.html">Prelude</a>
<a href="https://aiken-lang.github.io/prelude/aiken/builtin.html">Built-ins</a>
<a href="https://aiken-lang.github.io/stdlib">Stdlib</a>
</nav>
</header>
<div class="page">

View File

@ -222,6 +222,24 @@ p code {
margin: 0 var(--small-gap) 0 0;
}
.page-header nav {
display: flex;
height: 100%;
align-items: center;
justify-content: space-between;
padding-left: 2rem;
}
.page-header nav > a + a {
margin-left: 1rem;
}
@media (min-width: 919px) {
.page-header nav {
display: none;
}
}
/* Version selector */
#project-version {
@ -407,6 +425,12 @@ body.drawer-open .label-closed {
background-color: var(--color-background-accent);
}
@media(max-width: 770px) {
.member-name {
overflow-x: auto;
}
}
.member-name h2 {
display: flex;
font-size: 1.25rem;
@ -541,9 +565,11 @@ table tr:nth-child(2n) {
/* Pre-Wrap Option */
body.prewrap-on code,
body.prewrap-on pre {
white-space: pre-wrap;
@media(min-width: 769px) {
body.prewrap-on code,
body.prewrap-on pre {
white-space: pre-wrap;
}
}
/* Dark Theme Option */
@ -574,10 +600,8 @@ body.theme-dark {
}
/* Medium and larger displays */
@media (min-width: 680px) {
#prewrap-toggle {
display: none;
}
#prewrap-toggle {
display: none;
}
/* Small displays */