From a184afeecd70b3ff9d7f057c9c6c060cd4df8f61 Mon Sep 17 00:00:00 2001 From: Ellie Huxtable Date: Wed, 26 Jul 2023 09:47:45 +0100 Subject: Tidy up docs (#1120) --- docs/docs/guide/index.md | 1 + docs/docusaurus.config.js | 30 ++++----------------- docs/src/css/custom.css | 6 ++++- docs/src/pages/index.js | 67 ---------------------------------------------- docs/static/img/atuin.png | Bin 0 -> 1104144 bytes 5 files changed, 11 insertions(+), 93 deletions(-) delete mode 100644 docs/src/pages/index.js create mode 100644 docs/static/img/atuin.png (limited to 'docs') 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 ( -
- - - -
-

Making your shell magical

-

Sync, search and backup shell history with Atuin

-
- - Get Started - -
-
-
- ); -} - -export default function Home() { - const { siteConfig } = useDocusaurusContext(); - - return ( - - -
-
-
-

What is Atuin?

-
- -
-

Atuin is a command-line tool that enables you to make better use of your shell, by giving ctrl-r superpowers.

-

Every line you write is stored - ready to be queried and run again at any point, from any machine you wish. Never forget again!

-

Sync your history between all of your machines, and search it from anywhere

-
-
- -
-
-

Generate statistics from your shell history, such as this activity graph

-
-
- -
-
- - -
-
-
-
- ); -} diff --git a/docs/static/img/atuin.png b/docs/static/img/atuin.png new file mode 100644 index 00000000..b5cd5a4a Binary files /dev/null and b/docs/static/img/atuin.png differ -- cgit v1.2.3