Commit de46acac authored by hyeryung's avatar hyeryung

Merge branch 'master' into 'master'

update doc style

See merge request swd/swlab-ui!3
parents 4195efed 557c7cbf
This diff is collapsed.
antoraVersion: '1.0.0' antoraVersion: "1.0.0"
site: site:
url: http://localhost:5252 url: http://localhost:5252
title: Brand Docs title: Brand Docs
...@@ -6,15 +6,15 @@ site: ...@@ -6,15 +6,15 @@ site:
components: components:
- name: abc - name: abc
title: Project ABC title: Project ABC
url: '#' url: "#"
versions: versions:
- &latest_version_abc - &latest_version_abc
url: '#' url: "#"
version: '1.1' version: "1.1"
displayVersion: '1.1' displayVersion: "1.1"
- url: '#' - url: "#"
version: '1.0' version: "1.0"
displayVersion: '1.0' displayVersion: "1.0"
latestVersion: *latest_version_abc latestVersion: *latest_version_abc
- &component - &component
name: xyz name: xyz
...@@ -23,34 +23,34 @@ site: ...@@ -23,34 +23,34 @@ site:
versions: versions:
- &latest_version_xyz - &latest_version_xyz
url: /xyz/6.0/index.html url: /xyz/6.0/index.html
version: '6.0' version: "6.0"
displayVersion: '6.0' displayVersion: "6.0"
- &component_version - &component_version
title: *component_title title: *component_title
url: '#' url: "#"
version: '5.2' version: "5.2"
displayVersion: '5.2' displayVersion: "5.2"
- url: '#' - url: "#"
version: '5.1' version: "5.1"
displayVersion: '5.1' displayVersion: "5.1"
- url: '#' - url: "#"
version: '5.0' version: "5.0"
displayVersion: '5.0' displayVersion: "5.0"
latestVersion: *latest_version_xyz latestVersion: *latest_version_xyz
- name: '123' - name: "123"
title: Project 123 title: Project 123
url: '#' url: "#"
versions: versions:
- &latest_version_123 - &latest_version_123
url: '#' url: "#"
version: '2.2' version: "2.2"
displayVersion: '2.2' displayVersion: "2.2"
- url: '#' - url: "#"
version: '2.1' version: "2.1"
displayVersion: '2.1' displayVersion: "2.1"
- url: '#' - url: "#"
version: '2.0' version: "2.0"
displayVersion: '2.0' displayVersion: "2.0"
latestVersion: *latest_version_123 latestVersion: *latest_version_123
page: page:
url: *home_url url: *home_url
...@@ -58,8 +58,8 @@ page: ...@@ -58,8 +58,8 @@ page:
title: Brand’s Hardware & Software Requirements title: Brand’s Hardware & Software Requirements
component: *component component: *component
componentVersion: *component_version componentVersion: *component_version
version: '5.2' version: "5.2"
displayVersion: '5.2' displayVersion: "5.2"
module: ROOT module: ROOT
relativeSrcPath: index.adoc relativeSrcPath: index.adoc
editUrl: http://example.com/project-xyz/blob/main/index.adoc editUrl: http://example.com/project-xyz/blob/main/index.adoc
...@@ -67,60 +67,60 @@ page: ...@@ -67,60 +67,60 @@ page:
private: false private: false
previous: previous:
content: Quickstart content: Quickstart
url: '#' url: "#"
urlType: 'internal' urlType: "internal"
next: next:
content: Liber Recusabo content: Liber Recusabo
url: '#' url: "#"
urlType: 'internal' urlType: "internal"
breadcrumbs: breadcrumbs:
- content: Quickstart - content: Quickstart
url: '#' url: "#"
urlType: fragment urlType: fragment
- content: Brand’s Hardware & Software Requirements - content: Brand’s Hardware & Software Requirements
url: /xyz/5.2/index.html url: /xyz/5.2/index.html
urlType: internal urlType: internal
versions: versions:
- version: '6.0' - version: "6.0"
displayVersion: '6.0' displayVersion: "6.0"
url: '#' url: "#"
- version: '5.2' - version: "5.2"
displayVersion: '5.2' displayVersion: "5.2"
url: '#' url: "#"
- version: '5.1' - version: "5.1"
displayVersion: '5.1' displayVersion: "5.1"
url: '#' url: "#"
- version: '5.0' - version: "5.0"
displayVersion: '5.0' displayVersion: "5.0"
missing: true missing: true
url: '#' url: "#"
navigation: navigation:
- root: true - root: true
items: items:
- content: Quickstart - content: Quickstart
url: '#' url: "#"
urlType: fragment urlType: fragment
items: items:
- content: Brand’s Hardware & Software Requirements - content: Brand’s Hardware & Software Requirements
url: /xyz/5.2/index.html url: /xyz/5.2/index.html
urlType: internal urlType: internal
- content: Cu Solet - content: Cu Solet
url: '/xyz/5.2/index.html#cu-solet' url: "/xyz/5.2/index.html#cu-solet"
urlType: internal urlType: internal
- content: English + 中文 - content: English + 中文
url: '/xyz/5.2/index.html#english+中文' url: "/xyz/5.2/index.html#english+中文"
urlType: internal urlType: internal
- content: Liber Recusabo - content: Liber Recusabo
url: '#liber-recusabo' url: "#liber-recusabo"
urlType: fragment urlType: fragment
- content: Reference - content: Reference
items: items:
- content: Keyboard Shortcuts - content: Keyboard Shortcuts
url: '#' url: "#"
urlType: fragment urlType: fragment
- content: Importing and Exporting - content: Importing and Exporting
url: '#' url: "#"
urlType: fragment urlType: fragment
- content: Some Code - content: Some Code
url: '/xyz/5.2/index.html#some-code' url: "/xyz/5.2/index.html#some-code"
urlType: internal urlType: internal
...@@ -29,31 +29,32 @@ ...@@ -29,31 +29,32 @@
} }
.doc h1 { .doc h1 {
font-weight: var(--h1-font-weight); font-size: 32px;
font-weight: 600;
} }
.doc h2 { .doc h2 {
font-weight: var(--h2-font-weight); font-size: 28px;
font-weight: 600;
} }
.doc h3 { .doc h3 {
font-weight: var(--h3-font-weight); font-weight: 600;
} }
.doc h4 { .doc h4 {
font-weight: var(--h4-font-weight); font-weight: 500;
} }
.doc h5 { .doc h5 {
font-weight: var(--h5-font-weight); font-weight: 500;
} }
.doc h6 { .doc h6 {
font-weight: var(--h6-font-weight); font-weight: 500;
} }
.doc > h1.page:first-child { .doc > h1.page:first-child {
font-size: calc(36 / var(--rem-base) * 1rem);
margin: 1.5rem 0; margin: 1.5rem 0;
} }
...@@ -71,6 +72,13 @@ ...@@ -71,6 +72,13 @@
margin-top: 1rem; margin-top: 1rem;
} }
.doc .sect1 {
background: var(--color-white);
padding: 25px;
border-radius: var(--content-border-radius);
box-shadow: 0 1px 2px 1px rgba(47, 56, 61, 0.15), 0 1px 2px rgba(47, 56, 61, 0.2);
}
#preamble + .sect1, #preamble + .sect1,
.doc .sect1 + .sect1 { .doc .sect1 + .sect1 {
margin-top: 2rem; margin-top: 2rem;
...@@ -84,10 +92,7 @@ ...@@ -84,10 +92,7 @@
} }
.doc h2:not(.discrete) { .doc h2:not(.discrete) {
border-bottom: 1px solid var(--section-divider-color); margin-top: 0;
margin-left: -1rem;
margin-right: -1rem;
padding: 0.4rem 1rem 0.1rem;
} }
.doc h3:not(.discrete), .doc h3:not(.discrete),
...@@ -106,9 +111,9 @@ ...@@ -106,9 +111,9 @@
width: 1.75ex; width: 1.75ex;
margin-left: -1.5ex; margin-left: -1.5ex;
visibility: hidden; visibility: hidden;
font-size: 0.8em; font-size: 0.6em;
font-weight: normal; font-weight: normal;
padding-top: 0.05em; padding-top: 0.3em;
} }
.doc h1 .anchor::before, .doc h1 .anchor::before,
...@@ -159,7 +164,7 @@ ...@@ -159,7 +164,7 @@
.doc thead code, .doc thead code,
.doc .colist > table code { .doc .colist > table code {
color: var(--code-font-color); color: var(--code-font-color);
background: var(--code-background); background: var(--color-smoke-40);
border-radius: 0.25em; border-radius: 0.25em;
font-size: 0.95em; font-size: 0.95em;
padding: 0.125em 0.25em; padding: 0.125em 0.25em;
...@@ -279,6 +284,13 @@ ...@@ -279,6 +284,13 @@
margin-top: 0.5rem; margin-top: 0.5rem;
} }
.doc table.tableblock thead th {
color: #64696c;
font-size: 0.75rem;
font-weight: 600;
text-transform: uppercase;
}
.doc table.tableblock pre { .doc table.tableblock pre {
font-size: inherit; font-size: inherit;
} }
...@@ -298,7 +310,7 @@ ...@@ -298,7 +310,7 @@
.doc table.tableblock, .doc table.tableblock,
.doc table.tableblock > * > tr > * { .doc table.tableblock > * > tr > * {
border: 0 solid var(--table-border-color); border-bottom: 0 solid var(--table-border-color);
} }
.doc table.tableblock h2 { .doc table.tableblock h2 {
...@@ -321,11 +333,6 @@ ...@@ -321,11 +333,6 @@
border-width: 1px 0; border-width: 1px 0;
} }
.doc table.grid-all > thead th,
.doc table.grid-rows > thead th {
border-bottom-width: 2.5px;
}
.doc table.frame-all { .doc table.frame-all {
border-width: 1px; border-width: 1px;
} }
...@@ -395,6 +402,8 @@ ...@@ -395,6 +402,8 @@
.doc .admonitionblock { .doc .admonitionblock {
margin: 1.4rem 0 0; margin: 1.4rem 0 0;
border-radius: var(--content-border-radius);
border: 1px solid var(--color-smoke-90);
} }
.doc .admonitionblock p, .doc .admonitionblock p,
...@@ -419,11 +428,30 @@ ...@@ -419,11 +428,30 @@
.doc .admonitionblock td.content { .doc .admonitionblock td.content {
padding: 1rem 1rem 0.75rem; padding: 1rem 1rem 0.75rem;
background: var(--admonition-background);
width: 100%; width: 100%;
word-wrap: anywhere; word-wrap: anywhere;
} }
.doc .admonitionblock.note {
background-color: #f6fafd;
}
.doc .admonitionblock.tip {
background-color: #f7f9fa;
}
.doc .admonitionblock.important {
background-color: #faf1f0;
}
.doc .admonitionblock.caution {
background-color: #faf1f0;
}
.doc .admonitionblock.warning {
background-color: #fff4e3;
}
.doc .admonitionblock td.icon { .doc .admonitionblock td.icon {
font-size: calc(15 / var(--rem-base) * 1rem); font-size: calc(15 / var(--rem-base) * 1rem);
left: 0; left: 0;
...@@ -530,22 +558,13 @@ ...@@ -530,22 +558,13 @@
} }
#preamble .abstract blockquote { #preamble .abstract blockquote {
background: var(--abstract-background); border-left: 5px solid var(--color-blue-70);
border-left: 5px solid var(--abstract-border-color);
color: var(--abstract-font-color); color: var(--abstract-font-color);
font-size: calc(16 / var(--rem-base) * 1rem); padding-left: 1.5em;
padding: 0.75em 1em;
} }
.doc .quoteblock, .doc .quoteblock .title {
.doc .verseblock { font-weight: 500;
background: var(--quote-background);
border-left: 5px solid var(--quote-border-color);
color: var(--quote-font-color);
}
.doc .quoteblock {
padding: 0.25rem 2rem 1.25rem;
} }
.doc .quoteblock .attribution { .doc .quoteblock .attribution {
...@@ -558,10 +577,6 @@ ...@@ -558,10 +577,6 @@
margin-top: 1rem; margin-top: 1rem;
} }
.doc .quoteblock .paragraph {
font-style: italic;
}
.doc .quoteblock cite { .doc .quoteblock cite {
padding-left: 1em; padding-left: 1em;
} }
...@@ -787,10 +802,9 @@ ...@@ -787,10 +802,9 @@
.doc .exampleblock > .content, .doc .exampleblock > .content,
.doc details.result > .content { .doc details.result > .content {
background: var(--example-background); background: var(--color-blue-10);
border: 0.25rem solid var(--example-border-color); border-radius: var(--content-border-radius);
border-radius: 0.5rem; padding: var(--content-padding);
padding: 0.75rem;
} }
.doc .exampleblock > .content::after, .doc .exampleblock > .content::after,
...@@ -834,11 +848,13 @@ ...@@ -834,11 +848,13 @@
.doc pre.highlight > code, .doc pre.highlight > code,
.doc .listingblock pre:not(.highlight), .doc .listingblock pre:not(.highlight),
.doc .literalblock pre { .doc .literalblock pre {
background: var(--pre-background); color: var(--color-smoke-40);
box-shadow: inset 0 0 1.75px var(--pre-border-color); background: var(--color-jet-90);
border-radius: var(--content-border-radius);
font-size: 15px;
display: block; display: block;
overflow-x: auto; overflow-x: auto;
padding: 0.875em; padding: var(--content-padding);
} }
.doc .listingblock > .content { .doc .listingblock > .content {
...@@ -1124,3 +1140,7 @@ ...@@ -1124,3 +1140,7 @@
.doc .userinput { .doc .userinput {
color: red; color: red;
} }
.doc mark {
background-color: var(--color-blue-90);
}
:root { :root {
/* colors */ /* colors */
--color-bwg-main: #0072ce;
--color-white: #fff; --color-white: #fff;
--color-smoke-10: #fefefe; --color-smoke-10: #fefefe;
--color-smoke-30: #fafafa; --color-smoke-30: #fafafa;
--color-smoke-40: #f2f0f8;
--color-smoke-50: #f5f5f5; --color-smoke-50: #f5f5f5;
--color-smoke-70: #f0f0f0; --color-smoke-70: #f0f0f0;
--color-smoke-80: #eceded;
--color-smoke-90: #e1e1e1; --color-smoke-90: #e1e1e1;
--color-gray-10: #c1c1c1; --color-gray-10: #c1c1c1;
--color-gray-30: #9c9c9c; --color-gray-30: #9c9c9c;
...@@ -16,10 +19,14 @@ ...@@ -16,10 +19,14 @@
--color-jet-50: #333; --color-jet-50: #333;
--color-jet-70: #222; --color-jet-70: #222;
--color-jet-80: #12071f; --color-jet-80: #12071f;
--color-jet-90: #28262e;
--color-black: #000; --color-black: #000;
--color-blue-10: #f8f9fd; --color-blue-10: #f8f9fd;
--color-blue-30: #dee2e6; --color-blue-30: #dee2e6;
--color-bwg-main: #0072ce; --color-blue-50: #f4f8fc;
--color-blue-70: #d8def6;
--color-blue-80: #e3e6f3;
--color-blue-90: #c0d1fe;
/* fonts */ /* fonts */
--rem-base: 18; /* used to compute rem value from desired pixel value (e.g., calc(18 / var(--rem-base) * 1rem) = 18px) */ --rem-base: 18; /* used to compute rem value from desired pixel value (e.g., calc(18 / var(--rem-base) * 1rem) = 18px) */
--body-font-size: 1.0625em; /* 17px */ --body-font-size: 1.0625em; /* 17px */
...@@ -86,12 +93,6 @@ ...@@ -86,12 +93,6 @@
--doc-margin: 0 auto; --doc-margin: 0 auto;
--doc-margin--desktop: 0 2rem; --doc-margin--desktop: 0 2rem;
--heading-font-color: var(--color-jet-80); --heading-font-color: var(--color-jet-80);
--h1-font-weight: var(--h-font-weight-bold);
--h2-font-weight: var(--h-font-weight-bold);
--h3-font-weight: var(--h-font-weight-bold);
--h4-font-weight: 500;
--h5-font-weight: 500;
--h6-font-weight: 500;
--alt-heading-font-weight: var(--body-font-weight-bold); --alt-heading-font-weight: var(--body-font-weight-bold);
--section-divider-color: var(--panel-border-color); --section-divider-color: var(--panel-border-color);
--link-font-color: #1565c0; --link-font-color: #1565c0;
...@@ -123,6 +124,8 @@ ...@@ -123,6 +124,8 @@
--table-border-color: var(--panel-border-color); --table-border-color: var(--panel-border-color);
--table-stripe-background: var(--panel-background); --table-stripe-background: var(--panel-background);
--table-footer-background: linear-gradient(to bottom, var(--color-smoke-70) 0%, var(--color-white) 100%); --table-footer-background: linear-gradient(to bottom, var(--color-smoke-70) 0%, var(--color-white) 100%);
--content-border-radius: 10px;
--content-padding: 15px 20px;
/* toc */ /* toc */
--toc-font-color: var(--nav-muted-color); --toc-font-color: var(--nav-muted-color);
--toc-heading-font-color: var(--doc-font-color); --toc-heading-font-color: var(--doc-font-color);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment