diff options
| author | Ellie Huxtable <ellie@elliehuxtable.com> | 2023-02-25 23:29:59 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-25 23:29:59 +0000 |
| commit | c558da5bebfebf239dde867f36cc35d56849accf (patch) | |
| tree | 2e75e2c479fa1d89632eafd8119e084243bafa5e /docs/docusaurus.config.js | |
| parent | Revert "Remove shortcut numbers (#708)" (#724) (diff) | |
| download | atuin-c558da5bebfebf239dde867f36cc35d56849accf.zip | |
Add fancy web docs (#725)
* Add initial site
* WIP again
* Replace docs with web docs
* Bring back translations
* Update README.md
* remove images
Diffstat (limited to '')
| -rw-r--r-- | docs/docusaurus.config.js | 133 |
1 files changed, 133 insertions, 0 deletions
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js new file mode 100644 index 00000000..18c75ff7 --- /dev/null +++ b/docs/docusaurus.config.js @@ -0,0 +1,133 @@ +// @ts-check +// Note: type annotations allow type checking and IDEs autocompletion + +const lightCodeTheme = require('prism-react-renderer/themes/github'); +const darkCodeTheme = require('prism-react-renderer/themes/dracula'); + +/** @type {import('@docusaurus/types').Config} */ +const config = { + title: 'Atuin', + tagline: 'Magical shell history 🐢✨', + favicon: 'img/favicon.ico', + + // Set the production url of your site here + url: 'https://atuin.sh', + // Set the /<baseUrl>/ pathname under which your site is served + // For GitHub pages deployment, it is often '/<projectName>/' + baseUrl: '/', + + // GitHub pages deployment config. + // If you aren't using GitHub pages, you don't need these. + organizationName: 'ellie', // Usually your GitHub org/user name. + projectName: 'atuin', // Usually your repo name. + + onBrokenLinks: 'throw', + onBrokenMarkdownLinks: 'warn', + + // Even if you don't use internalization, you can use this field to set useful + // metadata like html lang. For example, if your site is Chinese, you may want + // to replace "en" with "zh-Hans". + i18n: { + defaultLocale: 'en', + locales: ['en'], + }, + + plugins: [], + + presets: [ + [ + 'classic', + /** @type {import('@docusaurus/preset-classic').Options} */ + ({ + docs: { + sidebarPath: require.resolve('./sidebars.js'), + // Please change this to your repo. + // Remove this to remove the "edit this page" links. + editUrl: + 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + }, + blog: { + showReadingTime: true, + // Please change this to your repo. + // Remove this to remove the "edit this page" links. + editUrl: + 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + }, + theme: { + customCss: require.resolve('./src/css/custom.css'), + }, + }), + ], + ], + + themeConfig: + /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ + ({ + // Replace with your project's social card + image: 'img/docusaurus-social-card.jpg', + navbar: { + title: '🐢 Atuin', + items: [ + { + type: 'doc', + docId: 'setup/setup', + position: 'left', + label: 'Docs', + }, + { to: '/blog', label: 'Blog', position: 'left' }, + { + href: 'https://github.com/ellie/atuin', + label: 'GitHub', + position: 'right', + }, + ], + }, + footer: { + style: 'dark', + links: [ + { + title: 'Docs', + items: [ + { + label: 'Setup', + to: '/docs/setup', + }, + ], + }, + { + title: 'Community', + items: [ + { + label: 'Discord', + href: 'https://discord.gg/Fq8bJSKPHh' + } + ], + }, + { + title: 'More', + items: [ + { + label: 'Blog', + to: '/blog', + }, + { + label: 'GitHub', + href: 'https://github.com/ellie/atuin', + }, + { + label: 'Twitter', + href: 'https://twitter.com/atuinsh' + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} Atuin.`, + }, + prism: { + theme: lightCodeTheme, + darkTheme: darkCodeTheme, + }, + }), +}; + +module.exports = config; |
