From f0cea844716a0871485504f091110b873d7fc668 Mon Sep 17 00:00:00 2001 From: cupcakearmy Date: Sun, 19 Feb 2023 14:06:57 +0100 Subject: [PATCH] cleanup --- README.md | 42 +++--------------------------- babel.config.js | 2 +- docusaurus.config.js | 32 +++++------------------ package.json | 2 +- pnpm-lock.yaml | 62 ++++++++++++++++++++++++-------------------- sidebars.js | 34 +++--------------------- 6 files changed, 48 insertions(+), 126 deletions(-) diff --git a/README.md b/README.md index aaba2fa..2aa1034 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,5 @@ -# Website +# Memoir -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +This is supposed to be a collection of tips, templates, notes, whatever learning that I think might be useful in the future again. The aim is to provide a place where I can lookup stuff I've done before. -### Installation - -``` -$ yarn -``` - -### Local Development - -``` -$ yarn start -``` - -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. - -### Build - -``` -$ yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -### Deployment - -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: - -``` -$ GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +The aim is not to provide detailed explanations of everything, but rather have a quick way to remind myself how something works/is setup/etc. diff --git a/babel.config.js b/babel.config.js index e00595d..6752648 100644 --- a/babel.config.js +++ b/babel.config.js @@ -1,3 +1,3 @@ module.exports = { presets: [require.resolve('@docusaurus/core/lib/babel/preset')], -}; +} diff --git a/docusaurus.config.js b/docusaurus.config.js index ddc3d6d..f6fd406 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,33 +1,20 @@ -// @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: 'Memoir', tagline: 'Memoirs of developing, deploying, hosting', favicon: 'img/favicon.ico', - // TODO: Right url - // Set the production url of your site here - url: 'https://your-docusaurus-test-site.com', - // Set the // pathname under which your site is served - // For GitHub pages deployment, it is often '//' + url: 'https://memoir.nicco.io', baseUrl: '/', - // GitHub pages deployment config. - // If you aren't using GitHub pages, you don't need these. - organizationName: 'cupcakearmy', // Usually your GitHub org/user name. - projectName: 'memoir', // Usually your repo name. + organizationName: 'cupcakearmy', + projectName: 'memoir', 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'], @@ -36,27 +23,21 @@ const config = { 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. - // TODO: Right URL - editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + editUrl: 'https://github.com/cupcakearmy/memoir/tree/main', }, 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: 'Memoir', items: [ @@ -69,7 +50,6 @@ const config = { ], }, footer: { - // style: 'dark', links: [ { title: 'Links', diff --git a/package.json b/package.json index 8a00da9..4eb3d70 100644 --- a/package.json +++ b/package.json @@ -41,6 +41,6 @@ ] }, "engines": { - "node": ">=16.14" + "node": ">=18" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e3febb6..4ba565b 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -2349,7 +2349,7 @@ packages: '@types/history': 4.7.11 '@types/react': 18.0.28 commander: 5.1.0 - joi: 17.7.1 + joi: 17.8.1 react: 17.0.2 react-dom: 17.0.2_react@17.0.2 react-helmet-async: 1.3.0_sfoxds7t5ydpegc3knd667wn6m @@ -2393,7 +2393,7 @@ packages: dependencies: '@docusaurus/logger': 2.3.0 '@docusaurus/utils': 2.3.0 - joi: 17.7.1 + joi: 17.8.1 js-yaml: 4.1.0 tslib: 2.5.0 transitivePeerDependencies: @@ -2411,7 +2411,7 @@ packages: dependencies: '@docusaurus/logger': 2.3.0 '@docusaurus/utils': 2.3.0_@docusaurus+types@2.3.0 - joi: 17.7.1 + joi: 17.8.1 js-yaml: 4.1.0 tslib: 2.5.0 transitivePeerDependencies: @@ -2490,13 +2490,29 @@ packages: - webpack-cli dev: false - /@hapi/hoek/9.3.0: - resolution: {integrity: sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ==} - - /@hapi/topo/5.1.0: - resolution: {integrity: sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg==} + /@hapi/address/5.1.0: + resolution: {integrity: sha512-b/OicomrGhG+aRgAhtxqOArHDH7kE2sY0IQ5MwIU6EkzUIOmsfi4YfYPZxGSauHLgVzcwk2rseCi7fjeMpQh+w==} + engines: {node: '>=14.0.0'} dependencies: - '@hapi/hoek': 9.3.0 + '@hapi/hoek': 11.0.2 + + /@hapi/formula/3.0.2: + resolution: {integrity: sha512-hY5YPNXzw1He7s0iqkRQi+uMGh383CGdyyIGYtB+W5N3KHPXoqychklvHhKCC9M3Xtv0OCs/IHw+r4dcHtBYWw==} + + /@hapi/hoek/11.0.2: + resolution: {integrity: sha512-aKmlCO57XFZ26wso4rJsW4oTUnrgTFw2jh3io7CAtO9w4UltBNwRXvXIVzzyfkaaLRo3nluP/19msA8vDUUuKw==} + + /@hapi/pinpoint/2.0.1: + resolution: {integrity: sha512-EKQmr16tM8s16vTT3cA5L0kZZcTMU5DUOZTuvpnY738m+jyP3JIUj+Mm1xc1rsLkGBQ/gVnfKYPwOmPg1tUR4Q==} + + /@hapi/tlds/1.0.1: + resolution: {integrity: sha512-OXs5OliWsLTmvzQKZtb3KhfEz30WuuaizwAn95GLfeK+JpGnBxR55lALv3kA4T1RRb3wlrNjnboBg6ur1Czvig==} + engines: {node: '>=14.0.0'} + + /@hapi/topo/6.0.1: + resolution: {integrity: sha512-JioWUZL1Bm7r8bnCDx2AUggiPwpV7djFfDTWT1aZSyHjN++fVz7XPdW8YVCxvyv9bSWcbbOLV/h4U1zGdwrN3w==} + dependencies: + '@hapi/hoek': 11.0.2 /@jest/schemas/29.4.3: resolution: {integrity: sha512-VLYKXQmtmuEz6IxJsrZwzG9NvtkQsWNnWMsKxqWNu3+CnfzJQhp0WDDKWLVV9hLKr0l3SLLFRqcYHjhtyuDVxg==} @@ -2623,17 +2639,6 @@ packages: resolution: {integrity: sha512-a5Sab1C4/icpTZVzZc5Ghpz88yQtGOyNqYXcZgOssB2uuAr+wF/MvN6bgtW32q7HHrvBki+BsZ0OuNv6EV3K9g==} dev: false - /@sideway/address/4.1.4: - resolution: {integrity: sha512-7vwq+rOHVWjyXxVlR76Agnvhy8I9rpzjosTESvmhNeXOXdZZB15Fl+TI9x1SiHZH5Jv2wTGduSxFDIaq0m3DUw==} - dependencies: - '@hapi/hoek': 9.3.0 - - /@sideway/formula/3.0.1: - resolution: {integrity: sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg==} - - /@sideway/pinpoint/2.0.0: - resolution: {integrity: sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ==} - /@sinclair/typebox/0.25.23: resolution: {integrity: sha512-VEB8ygeP42CFLWyAJhN5OklpxUliqdNEUcXb4xZ/CINqtYGTjL5ukluKdKzQ0iWdUxyQ7B0539PAUhHKrCNWSQ==} dev: false @@ -5563,14 +5568,15 @@ packages: supports-color: 8.1.1 dev: false - /joi/17.7.1: - resolution: {integrity: sha512-teoLhIvWE298R6AeJywcjR4sX2hHjB3/xJX4qPjg+gTg+c0mzUDsziYlqPmLomq9gVsfaMcgPaGc7VxtD/9StA==} + /joi/17.8.1: + resolution: {integrity: sha512-Zoafe6E2kQ+hkkJQSBnOxA8beb2LF33keCxZP3vSy7qTHj9/2GAEQ9KLwfe+PR35WvspwNz0jWajDIHLnCKfpg==} dependencies: - '@hapi/hoek': 9.3.0 - '@hapi/topo': 5.1.0 - '@sideway/address': 4.1.4 - '@sideway/formula': 3.0.1 - '@sideway/pinpoint': 2.0.0 + '@hapi/address': 5.1.0 + '@hapi/formula': 3.0.2 + '@hapi/hoek': 11.0.2 + '@hapi/pinpoint': 2.0.1 + '@hapi/tlds': 1.0.1 + '@hapi/topo': 6.0.1 /js-tokens/4.0.0: resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==} @@ -8186,7 +8192,7 @@ packages: hasBin: true dependencies: axios: 0.25.0 - joi: 17.7.1 + joi: 17.8.1 lodash: 4.17.21 minimist: 1.2.8 rxjs: 7.8.0 diff --git a/sidebars.js b/sidebars.js index 9ab54c2..08694d2 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,33 +1,5 @@ -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - -// @ts-check - -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], +} - // But you can create a sidebar manually - /* - tutorialSidebar: [ - 'intro', - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], - */ -}; - -module.exports = sidebars; +module.exports = sidebars