Skip to content

chore: update README for v3 #1041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
370 changes: 160 additions & 210 deletions README.md
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have completely rewritten the README. Could you check if there’s any missing information?

Large diffs are not rendered by default.

247 changes: 184 additions & 63 deletions docs-svelte-kit/src/app.css
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’ve tidied up the site’s style. Please check if there are any design issues.

Original file line number Diff line number Diff line change
@@ -1,105 +1,226 @@
@import "@fontsource/fira-mono";
@import '@fontsource/fira-mono';
@import 'prismjs/themes/prism-tomorrow';
@import '@shikijs/twoslash/style-rich.css';

:root {
font-family: Arial, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif;
--font-mono: "Fira Mono", monospace;
--pure-white: #ffffff;
--primary-color: #b9c6d2;
--secondary-color: #676778;
--tertiary-color: #edf0f8;
--accent-color: #ff3e00;
--heading-color: rgba(0, 0, 0, 0.7);
--text-color: #444444;
--background-without-opacity: rgba(255, 255, 255, 0.7);
--column-width: 42rem;
--column-margin-top: 4rem;
font-family: 'Inter', 'Helvetica Neue', 'Arial', sans-serif;
--font-mono: 'Fira Mono', monospace;
--pure-white: #ffffff;
--primary-color: #ffffff;
--secondary-color: #676778;
--tertiary-color: #edf0f8;
--accent-color: #ff3e00;
--heading-color: rgba(0, 0, 0, 0.7);
--text-color: #444444;
--background-without-opacity: rgba(255, 255, 255, 0.95);
--column-width: 42rem;
--column-margin-top: 4rem;
}

body {
min-height: 100vh;
margin: 0;
background-color: var(--primary-color);
}

body::before {
content: "";
width: 80vw;
height: 100vh;
position: absolute;
top: 0;
left: 10vw;
z-index: -1;
background: radial-gradient(
50% 50% at 50% 50%,
var(--pure-white) 0%,
rgba(255, 255, 255, 0) 100%
);
opacity: 0.05;
min-height: 100vh;
margin: 0;
background-color: var(--primary-color);
color: var(--text-color);
}

#svelte {
min-height: 100vh;
display: flex;
flex-direction: column;
min-height: 100vh;
display: flex;
flex-direction: column;
}

h1,
h2,
p {
font-weight: 400;
color: var(--heading-color);
font-weight: 400;
color: var(--heading-color);
}

p {
line-height: 1.5;
line-height: 1.5;
}

a {
color: var(--accent-color);
text-decoration: none;
color: var(--accent-color);
text-decoration: none;
}

a:hover {
text-decoration: underline;
text-decoration: underline;
}

h1 {
font-size: 2rem;
text-align: center;
font-size: 2rem;
margin: 1rem 0;
}
@media (min-width: 720px) {
h1 {
font-size: 2.4rem;
}
}

h2 {
font-size: 1rem;
font-size: 1.6rem;
margin: 1rem 0;
}

h3,
h4,
h5,
h6 {
margin: 0.5rem 0;
font-weight: 400;
color: var(--heading-color);
font-size: 1rem;
}

h1 + h2,
h2 + h3,
h3 + h4,
h4 + h5,
h5 + h6 {
margin-top: 0;
}

ul {
margin: 1rem 0;
}

pre {
font-size: 16px;
font-family: var(--font-mono);
background-color: rgba(255, 255, 255, 0.45);
border-radius: 3px;
box-shadow: 2px 2px 6px rgb(255 255 255 / 25%);
padding: 0.5em;
overflow-x: auto;
color: var(--text-color);
font-size: 16px;
font-family: var(--font-mono);
background-color: rgba(255, 255, 255, 0.45);
border-radius: 3px;
box-shadow: 2px 2px 6px rgb(255 255 255 / 25%);
padding: 0.5em;
overflow-x: auto;
color: var(--text-color);
margin: 0.5rem 0;
}

input,
button {
font-size: inherit;
font-family: inherit;
font-size: inherit;
font-family: inherit;
}

button:focus:not(:focus-visible) {
outline: none;
outline: none;
}

@media (min-width: 720px) {
h1 {
font-size: 2.4rem;
}
:target {
scroll-margin-top: 80px;
}

:target {
scroll-margin-top: 80px;
/* twoslash */
.twoslash .twoslash-popup-container {
transform: translateY(2em);
white-space: pre-wrap;
margin-right: 32px;
}
.twoslash .twoslash-error > span:not(.twoslash-popup-container):not(:has(*)) {
min-width: 6px;
display: inline-block;
}

/*** markdown ***/
:not(pre) > code {
padding: 0.1rem 0.4rem;
margin: 0 0.2rem;
background: #e5eef5;
position: relative;
border-radius: 0.3em;
white-space: nowrap;
color: #444;
-webkit-font-smoothing: initial;
transform: translateY(-2px);
display: inline-block;
}

blockquote {
padding: 0.5rem 2.4rem;
color: #09f;
border: 1px solid #40b3ff;
margin: 1.6rem 2.4rem 2.4rem;
border-radius: 0.4rem;
}
blockquote p {
color: #09f;
}

table {
margin: 0 0 2em;
width: 100%;
font-size: 1rem; /* var(--h5)は未定義なので1remに */
}
td,
th {
text-align: left;
border-bottom: 1px solid rgba(0 0 0 / 0.1);
padding: 0.4rem 0.8rem 0.4rem 0;
}

/* custom container */
.custom-block .custom-block-title {
font-weight: 600;
margin-bottom: -0.4rem;
}

.custom-block.danger,
.custom-block.tip,
.custom-block.warning {
padding: 0.1rem 1.5rem;
border-left-width: 4px;
border-left-style: solid;
margin: 1rem 0;
}

.custom-block.tip {
background-color: #f3f5f7;
border-color: #42b983;
}

.custom-block.warning {
background-color: rgba(255, 229, 100, 0.3);
border-color: #e7c000;
color: #6b5900;
}
.custom-block.warning .custom-block-title {
color: #b29400;
}
.custom-block.warning a {
color: #2c3e50;
}

.custom-block.danger {
background-color: #ffe6e6;
border-color: #c00;
color: #4d0000;
}
.custom-block.danger .custom-block-title {
color: #900;
}
.custom-block.danger a {
color: #2c3e50;
}

.custom-block.details {
display: block;
position: relative;
border-radius: 2px;
margin: 1.6em 0;
padding: 1.6em;
background-color: #eee;
}
.custom-block.details h4 {
margin-top: 0;
}
.custom-block.details figure:last-child,
.custom-block.details p:last-child {
margin-bottom: 0;
padding-bottom: 0;
}
.custom-block.details summary {
outline: none;
cursor: pointer;
}
63 changes: 33 additions & 30 deletions docs-svelte-kit/src/lib/footer/Footer.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -47,27 +47,25 @@
target="_blank"
rel="noopener noreferrer">Edit this page</a
>
<span>
<svg
xmlns="http://www.w3.org/2000/svg"
aria-hidden="true"
focusable="false"
x="0px"
y="0px"
viewBox="0 0 100 100"
width="15"
height="15"
class="icon outbound"
><path
fill="currentColor"
d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"
/>
<polygon
fill="currentColor"
points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"
/>
</svg>
</span>
<svg
xmlns="http://www.w3.org/2000/svg"
aria-hidden="true"
focusable="false"
x="0px"
y="0px"
viewBox="0 0 100 100"
width="15"
height="15"
class="icon outbound"
><path
fill="currentColor"
d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"
/>
<polygon
fill="currentColor"
points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"
/>
</svg>
</div>
{#if fileInfo.lastUpdated}
<div class="last-updated">
Expand All @@ -85,29 +83,34 @@
{/if}
</div>
<div class="footer-text">
<span
>This site was built with <a href="https://kit.svelte.dev/" target="_brank">SvelteKit</a
>.</span
>
<span>
This site was built with <a href="https://kit.svelte.dev/" target="_brank">SvelteKit</a>.
</span>
</div>
</footer>

<style>
.footer-tools {
width: 100%;
padding: 1rem;
padding: 0 1rem;
box-sizing: border-box;
display: flex;
}

.edit-link {
display: flex;
gap: 4px;
}

.footer-move {
border-top: 1px solid var(--background-without-opacity);
width: 100%;
padding: 1rem;
padding: 0 1rem;
box-sizing: border-box;
display: flex;
}
.footer-text {
padding: 1rem;
padding: 0 1rem 1rem 1rem;
display: flex;
flex-direction: column;
justify-content: center;
Expand Down Expand Up @@ -139,7 +142,7 @@
flex-direction: column;
justify-content: center;
align-items: center;
padding: 40px;
padding: 16px 0 0 0;
}

footer a {
Expand All @@ -148,7 +151,7 @@

@media (min-width: 480px) {
footer {
padding: 40px 0;
padding: 24px 0 0 0;
}
}
</style>
Loading
Loading