michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

improve introduction page of example/docs

Browse source
This commit is contained in:
Fred K. Schott 2021-08-26 15:18:45 -07:00
parent 9f2b1d6071
commit e0c39fb217
4 changed files with 64 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
examples/docs/public/theme.css
View file

@ -58,7 +58,7 @@
color-scheme: light; color-scheme: light;
--theme-accent: hsla(var(--color-blue), 1); --theme-accent: hsla(var(--color-blue), 1);
--theme-text-accent: hsla(var(--color-blue), 1); --theme-text-accent: hsla(var(--color-blue), 1);
--theme-accent-opacity: 0.1; --theme-accent-opacity: 0.15;
--theme-divider: hsla(var(--color-gray-95), 1); --theme-divider: hsla(var(--color-gray-95), 1);
--theme-text: hsla(var(--color-gray-10), 1); --theme-text: hsla(var(--color-gray-10), 1);
--theme-text-light: hsla(var(--color-gray-40), 1); --theme-text-light: hsla(var(--color-gray-40), 1);
@ -85,9 +85,9 @@ body {
:root.theme-dark { :root.theme-dark {
color-scheme: dark; color-scheme: dark;
--theme-accent-opacity: 0.4; --theme-accent-opacity: 0.15;
--theme-accent: hsla(var(--color-orange), 1); --theme-accent: hsla(var(--color-blue), 1);
--theme-text-accent: hsla(var(--color-orange), 1); --theme-text-accent: hsla(var(--color-blue), 1);
--theme-divider: hsla(var(--color-gray-10), 1); --theme-divider: hsla(var(--color-gray-10), 1);
--theme-text: hsla(var(--color-gray-90), 1); --theme-text: hsla(var(--color-gray-90), 1);
--theme-text-light: hsla(var(--color-gray-80), 1); --theme-text-light: hsla(var(--color-gray-80), 1);

102
examples/docs/src/components/RightSidebar/MoreMenu.astro
View file

@ -1,6 +1,8 @@
--- ---
import ThemeToggleButton from './ThemeToggleButton.jsx'; import ThemeToggleButton from './ThemeToggleButton.jsx';
import * as CONFIG from '../../config.js';
const {editHref} = Astro.props; const {editHref} = Astro.props;
const showMoreSection = (CONFIG.COMMUNITY_INVITE_URL || editHref);
--- ---
<style> <style>
.edit-on-github { .edit-on-github {
@ -10,58 +12,56 @@ const {editHref} = Astro.props;
font-size: 1rem; font-size: 1rem;
} }
</style> </style>
<h2 class="heading">More</h2> {showMoreSection && <h2 class="heading">More</h2>}
<ul> <ul>
<li class={`header-link depth-2`}> {editHref &&
<a class="edit-on-github" href={editHref} target="_blank"> <li class={`header-link depth-2`}>
<svg <a class="edit-on-github" href={editHref} target="_blank">
aria-hidden="true" <svg
focusable="false" aria-hidden="true"
data-prefix="fas" focusable="false"
data-icon="pen" data-prefix="fas"
class="svg-inline--fa fa-pen fa-w-16" data-icon="pen"
role="img" class="svg-inline--fa fa-pen fa-w-16"
xmlns="http://www.w3.org/2000/svg" role="img"
viewBox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"
height="1em" viewBox="0 0 512 512"
width="1em" height="1em"
> width="1em"
<path >
fill="currentColor" <path
d="M290.74 93.24l128.02 128.02-277.99 277.99-114.14 12.6C11.35 513.54-1.56 500.62.14 485.34l12.7-114.22 277.9-277.88zm207.2-19.06l-60.11-60.11c-18.75-18.75-49.16-18.75-67.91 0l-56.55 56.55 128.02 128.02 56.55-56.55c18.75-18.76 18.75-49.16 0-67.91z" fill="currentColor"
></path> d="M290.74 93.24l128.02 128.02-277.99 277.99-114.14 12.6C11.35 513.54-1.56 500.62.14 485.34l12.7-114.22 277.9-277.88zm207.2-19.06l-60.11-60.11c-18.75-18.75-49.16-18.75-67.91 0l-56.55 56.55 128.02 128.02 56.55-56.55c18.75-18.76 18.75-49.16 0-67.91z"
</svg> ></path>
<span>Edit this page</span> </svg>
</a> <span>Edit this page</span>
</li> </a>
<li class={`header-link depth-2`}> </li>
<a href="https://github.com/snowpackjs/astro/blob/main/CONTRIBUTING.md#translations" target="_blank"> }
<svg aria-hidden="true" focusable="false" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 88.6 77.3" height="1.24em" width="1.24em" style="margin: -2px;"> <path fill="currentColor" d="M61,24.6h7.9l18.7,51.6h-7.7l-5.4-15.5H54.3l-5.6,15.5h-7.2L61,24.6z M72.6,55l-8-22.8L56.3,55H72.6z" /> <path fill="currentColor" d="M53.6,60.6c-10-4-16-9-22-14c0,0,1.3,1.3,0,0c-6,5-20,13-20,13l-4-6c8-5,10-6,19-13c-2.1-1.9-12-13-13-19h8 c4,9,10,14,10,14c10-8,10-19,10-19h8c0,0-1,13-12,24l0,0c5,5,10,9,19,13L53.6,60.6z M1.6,16.6h56v-8h-23v-7h-9v7h-24V16.6z" /> </svg> {CONFIG.COMMUNITY_INVITE_URL &&
<span>Translate this page</span> <li class={`header-link depth-2`}>
</a> <a href="https://astro.build/chat" target="_blank">
</li> <svg
<li class={`header-link depth-2`}> aria-hidden="true"
<a href="https://astro.build/chat" target="_blank"> focusable="false"
<svg data-prefix="fas"
aria-hidden="true" data-icon="comment-alt"
focusable="false" class="svg-inline--fa fa-comment-alt fa-w-16"
data-prefix="fas" role="img"
data-icon="comment-alt" xmlns="http://www.w3.org/2000/svg"
class="svg-inline--fa fa-comment-alt fa-w-16" viewBox="0 0 512 512"
role="img" height="1em"
xmlns="http://www.w3.org/2000/svg" width="1em"
viewBox="0 0 512 512" >
height="1em" <path
width="1em" fill="currentColor"
> d="M448 0H64C28.7 0 0 28.7 0 64v288c0 35.3 28.7 64 64 64h96v84c0 9.8 11.2 15.5 19.1 9.7L304 416h144c35.3 0 64-28.7 64-64V64c0-35.3-28.7-64-64-64z"
<path ></path>
fill="currentColor" </svg>
d="M448 0H64C28.7 0 0 28.7 0 64v288c0 35.3 28.7 64 64 64h96v84c0 9.8 11.2 15.5 19.1 9.7L304 416h144c35.3 0 64-28.7 64-64V64c0-35.3-28.7-64-64-64z" <span>Join our community</span>
></path> </a>
</svg> </li>
<span>Join our community</span> }
</a>
</li>
</ul> </ul>
<div style="margin: 2rem 0; text-align: center;"> <div style="margin: 2rem 0; text-align: center;">
<ThemeToggleButton client:visible /> <ThemeToggleButton client:visible />

6
examples/docs/src/config.ts
View file

@ -16,6 +16,12 @@ export const KNOWN_LANGUAGES = {
English: 'en', English: 'en',
}; };
// Uncomment this to add an "Edit this page" button to every page of documentation.
// export const GITHUB_EDIT_URL = `https://github.com/snowpackjs/astro/blob/main/docs/`;
// Uncomment this to add an "Join our Community" button to every page of documentation.
// export const COMMUNITY_INVITE_URL = `https://astro.build/chat`;
// Uncomment this to enable site search. // Uncomment this to enable site search.
// See "Algolia" section of the README for more information. // See "Algolia" section of the README for more information.
// export const ALGOLIA = { // export const ALGOLIA = {

6
examples/docs/src/layouts/MainLayout.astro
View file

@ -6,19 +6,19 @@ import Footer from '../components/Footer/Footer.astro';
import PageContent from '../components/PageContent/PageContent.astro'; import PageContent from '../components/PageContent/PageContent.astro';
import LeftSidebar from '../components/LeftSidebar/LeftSidebar.astro'; import LeftSidebar from '../components/LeftSidebar/LeftSidebar.astro';
import RightSidebar from '../components/RightSidebar/RightSidebar.astro'; import RightSidebar from '../components/RightSidebar/RightSidebar.astro';
import { SITE } from "../config.ts"; import * as CONFIG from "../config.ts";
const { content = {} } = Astro.props; const { content = {} } = Astro.props;
const currentPage = Astro.request.url.pathname; const currentPage = Astro.request.url.pathname;
const currentFile = `src/pages${currentPage.replace(/\/$/, "")}.md`; const currentFile = `src/pages${currentPage.replace(/\/$/, "")}.md`;
const githubEditUrl = `https://github.com/snowpackjs/astro/blob/main/docs/${currentFile}`; const githubEditUrl = CONFIG.GITHUB_EDIT_URL && (CONFIG.GITHUB_EDIT_URL + currentFile);
--- ---
<html dir="{content.dir ?? 'ltr'}" lang="{content.lang ?? 'en-us'}" class="initial"> <html dir="{content.dir ?? 'ltr'}" lang="{content.lang ?? 'en-us'}" class="initial">
<head> <head>
<HeadCommon /> <HeadCommon />
<HeadSEO {content} canonicalURL={Astro.request.canonicalURL} /> <HeadSEO {content} canonicalURL={Astro.request.canonicalURL} />
<title>{content.title ? `${content.title} 🚀 ${SITE.title}` : SITE.title}</title> <title>{content.title ? `${content.title} 🚀 ${CONFIG.SITE.title}` : CONFIG.SITE.title}</title>
<style> <style>
body { body {
width: 100%; width: 100%;