diff options
author | Ellie Huxtable <ellie@elliehuxtable.com> | 2023-07-26 09:47:45 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-26 09:47:45 +0100 |
commit | a184afeecd70b3ff9d7f057c9c6c060cd4df8f61 (patch) | |
tree | 9acab409e809ac44748ef20225135779ef60dd98 /docs | |
parent | 9ca26e57640912967f66b36b7bd352aba7317618 (diff) |
Tidy up docs (#1120)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/docs/guide/index.md | 1 | ||||
-rw-r--r-- | docs/docusaurus.config.js | 30 | ||||
-rw-r--r-- | docs/src/css/custom.css | 6 | ||||
-rw-r--r-- | docs/src/pages/index.js | 67 | ||||
-rw-r--r-- | docs/static/img/atuin.png | bin | 0 -> 1104144 bytes |
5 files changed, 11 insertions, 93 deletions
diff --git a/docs/docs/guide/index.md b/docs/docs/guide/index.md index f605f520..5fe56ccd 100644 --- a/docs/docs/guide/index.md +++ b/docs/docs/guide/index.md @@ -1,6 +1,7 @@ --- title: Getting Started id: index +slug: / sidebar_position: 1 --- diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index d0031f84..a33d8f63 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -66,31 +66,11 @@ const config = { ({ // Replace with your project's social card navbar: { - title: '🐢 Atuin', - items: [ - { - type: 'doc', - docId: 'guide/index', - position: 'left', - label: 'Docs', - }, - { to: '/blog', label: 'Blog', position: 'left' }, - { - href: 'https://github.com/ellie/atuin', - label: 'GitHub', - position: 'right', - }, - { - href: 'https://hachyderm.io/@atuin', - label: 'Mastodon', - position: 'right', - }, - { - href: 'https://twitter.com/atuinsh', - label: 'Twitter', - position: 'right', - } - ], + logo: { + href: "https://atuin.sh", + src: "/img/atuin.png" + } + }, footer: { style: 'dark', diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 78be3a88..ffa1a79b 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -33,4 +33,8 @@ --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); } - +.navbar__logo { + height: 50px; + position: absolute; + top: 4px; +} diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js deleted file mode 100644 index de42742b..00000000 --- a/docs/src/pages/index.js +++ /dev/null @@ -1,67 +0,0 @@ -import React from 'react'; -import clsx from 'clsx'; -import Link from '@docusaurus/Link'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -import Layout from '@theme/Layout'; -import HomepageFeatures from '@site/src/components/HomepageFeatures'; - -import styles from './index.module.css'; - -function HomepageHeader() { - const { siteConfig } = useDocusaurusContext(); - return ( - <header className={clsx('hero', styles.heroBanner)}> - <link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>🐢</text></svg>" /> - <link rel="me" href="https://hachyderm.io/@atuin" /> - - <div className="container"> - <h1 className="hero__title">Making your shell <b className={styles.magical}>magical</b></h1> - <p className="hero__subtitle">Sync, search and backup shell history with Atuin</p> - <div className={styles.buttons}> - <Link - className="button button--primary button--lg" - to="/docs/guide"> - Get Started - </Link> - </div> - </div> - </header> - ); -} - -export default function Home() { - const { siteConfig } = useDocusaurusContext(); - - return ( - <Layout - title={`Magical Shell History`}> - <HomepageHeader /> - <main> - <section className={styles.whatis}> - <div className="container"> - <center><h1>What is <b>Atuin</b>?</h1></center> - <div className="row"> - <img src="/img/screenshot.png" className="col col--8" /> - <div className="col col--4"> - <p>Atuin is a command-line tool that enables you to make better use of your shell, by giving ctrl-r superpowers.</p> - <p>Every line you write is stored - ready to be queried and run again at any point, from any machine you wish. Never forget again!</p> - <p>Sync your history between all of your machines, and search it from anywhere</p> - </div> - </div> - - <div className="row" style={{ paddingTop: "18px", alignItems: "center" }}> - <div className="col col--4"> - <p>Generate statistics from your shell history, such as this activity graph</p> - </div> - <div className="col col--8"> - <img src="https://api.atuin.sh/img/ellie.png?token=0722830c382b42777bdb652da5b71efb61d8d387" /> - </div> - </div> - - <HomepageFeatures /> - </div> - </section> - </main> - </Layout > - ); -} diff --git a/docs/static/img/atuin.png b/docs/static/img/atuin.png Binary files differnew file mode 100644 index 00000000..b5cd5a4a --- /dev/null +++ b/docs/static/img/atuin.png |