This commit is contained in:
cupcakearmy 2023-02-19 14:06:57 +01:00
parent 178501233f
commit f0cea84471
No known key found for this signature in database
GPG Key ID: 3235314B4D31232F
6 changed files with 48 additions and 126 deletions

View File

@ -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 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.
```
$ 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=<Your GitHub username> 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.

View File

@ -1,3 +1,3 @@
module.exports = { module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')], presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
}; }

View File

@ -1,33 +1,20 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require('prism-react-renderer/themes/github') const lightCodeTheme = require('prism-react-renderer/themes/github')
const darkCodeTheme = require('prism-react-renderer/themes/dracula') const darkCodeTheme = require('prism-react-renderer/themes/dracula')
/** @type {import('@docusaurus/types').Config} */
const config = { const config = {
title: 'Memoir', title: 'Memoir',
tagline: 'Memoirs of developing, deploying, hosting', tagline: 'Memoirs of developing, deploying, hosting',
favicon: 'img/favicon.ico', favicon: 'img/favicon.ico',
// TODO: Right url url: 'https://memoir.nicco.io',
// Set the production url of your site here
url: 'https://your-docusaurus-test-site.com',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/', baseUrl: '/',
// GitHub pages deployment config. organizationName: 'cupcakearmy',
// If you aren't using GitHub pages, you don't need these. projectName: 'memoir',
organizationName: 'cupcakearmy', // Usually your GitHub org/user name.
projectName: 'memoir', // Usually your repo name.
onBrokenLinks: 'throw', onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn', 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: { i18n: {
defaultLocale: 'en', defaultLocale: 'en',
locales: ['en'], locales: ['en'],
@ -36,27 +23,21 @@ const config = {
presets: [ presets: [
[ [
'classic', 'classic',
/** @type {import('@docusaurus/preset-classic').Options} */ {
({
docs: { docs: {
sidebarPath: require.resolve('./sidebars.js'), sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo. editUrl: 'https://github.com/cupcakearmy/memoir/tree/main',
// 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/',
}, },
theme: { theme: {
customCss: require.resolve('./src/css/custom.css'), customCss: require.resolve('./src/css/custom.css'),
}, },
}), },
], ],
], ],
themeConfig: themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */ /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({ ({
// Replace with your project's social card
// image: 'img/docusaurus-social-card.jpg',
navbar: { navbar: {
title: 'Memoir', title: 'Memoir',
items: [ items: [
@ -69,7 +50,6 @@ const config = {
], ],
}, },
footer: { footer: {
// style: 'dark',
links: [ links: [
{ {
title: 'Links', title: 'Links',

View File

@ -41,6 +41,6 @@
] ]
}, },
"engines": { "engines": {
"node": ">=16.14" "node": ">=18"
} }
} }

62
pnpm-lock.yaml generated
View File

@ -2349,7 +2349,7 @@ packages:
'@types/history': 4.7.11 '@types/history': 4.7.11
'@types/react': 18.0.28 '@types/react': 18.0.28
commander: 5.1.0 commander: 5.1.0
joi: 17.7.1 joi: 17.8.1
react: 17.0.2 react: 17.0.2
react-dom: 17.0.2_react@17.0.2 react-dom: 17.0.2_react@17.0.2
react-helmet-async: 1.3.0_sfoxds7t5ydpegc3knd667wn6m react-helmet-async: 1.3.0_sfoxds7t5ydpegc3knd667wn6m
@ -2393,7 +2393,7 @@ packages:
dependencies: dependencies:
'@docusaurus/logger': 2.3.0 '@docusaurus/logger': 2.3.0
'@docusaurus/utils': 2.3.0 '@docusaurus/utils': 2.3.0
joi: 17.7.1 joi: 17.8.1
js-yaml: 4.1.0 js-yaml: 4.1.0
tslib: 2.5.0 tslib: 2.5.0
transitivePeerDependencies: transitivePeerDependencies:
@ -2411,7 +2411,7 @@ packages:
dependencies: dependencies:
'@docusaurus/logger': 2.3.0 '@docusaurus/logger': 2.3.0
'@docusaurus/utils': 2.3.0_@docusaurus+types@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 js-yaml: 4.1.0
tslib: 2.5.0 tslib: 2.5.0
transitivePeerDependencies: transitivePeerDependencies:
@ -2490,13 +2490,29 @@ packages:
- webpack-cli - webpack-cli
dev: false dev: false
/@hapi/hoek/9.3.0: /@hapi/address/5.1.0:
resolution: {integrity: sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ==} resolution: {integrity: sha512-b/OicomrGhG+aRgAhtxqOArHDH7kE2sY0IQ5MwIU6EkzUIOmsfi4YfYPZxGSauHLgVzcwk2rseCi7fjeMpQh+w==}
engines: {node: '>=14.0.0'}
/@hapi/topo/5.1.0:
resolution: {integrity: sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg==}
dependencies: 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: /@jest/schemas/29.4.3:
resolution: {integrity: sha512-VLYKXQmtmuEz6IxJsrZwzG9NvtkQsWNnWMsKxqWNu3+CnfzJQhp0WDDKWLVV9hLKr0l3SLLFRqcYHjhtyuDVxg==} resolution: {integrity: sha512-VLYKXQmtmuEz6IxJsrZwzG9NvtkQsWNnWMsKxqWNu3+CnfzJQhp0WDDKWLVV9hLKr0l3SLLFRqcYHjhtyuDVxg==}
@ -2623,17 +2639,6 @@ packages:
resolution: {integrity: sha512-a5Sab1C4/icpTZVzZc5Ghpz88yQtGOyNqYXcZgOssB2uuAr+wF/MvN6bgtW32q7HHrvBki+BsZ0OuNv6EV3K9g==} resolution: {integrity: sha512-a5Sab1C4/icpTZVzZc5Ghpz88yQtGOyNqYXcZgOssB2uuAr+wF/MvN6bgtW32q7HHrvBki+BsZ0OuNv6EV3K9g==}
dev: false 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: /@sinclair/typebox/0.25.23:
resolution: {integrity: sha512-VEB8ygeP42CFLWyAJhN5OklpxUliqdNEUcXb4xZ/CINqtYGTjL5ukluKdKzQ0iWdUxyQ7B0539PAUhHKrCNWSQ==} resolution: {integrity: sha512-VEB8ygeP42CFLWyAJhN5OklpxUliqdNEUcXb4xZ/CINqtYGTjL5ukluKdKzQ0iWdUxyQ7B0539PAUhHKrCNWSQ==}
dev: false dev: false
@ -5563,14 +5568,15 @@ packages:
supports-color: 8.1.1 supports-color: 8.1.1
dev: false dev: false
/joi/17.7.1: /joi/17.8.1:
resolution: {integrity: sha512-teoLhIvWE298R6AeJywcjR4sX2hHjB3/xJX4qPjg+gTg+c0mzUDsziYlqPmLomq9gVsfaMcgPaGc7VxtD/9StA==} resolution: {integrity: sha512-Zoafe6E2kQ+hkkJQSBnOxA8beb2LF33keCxZP3vSy7qTHj9/2GAEQ9KLwfe+PR35WvspwNz0jWajDIHLnCKfpg==}
dependencies: dependencies:
'@hapi/hoek': 9.3.0 '@hapi/address': 5.1.0
'@hapi/topo': 5.1.0 '@hapi/formula': 3.0.2
'@sideway/address': 4.1.4 '@hapi/hoek': 11.0.2
'@sideway/formula': 3.0.1 '@hapi/pinpoint': 2.0.1
'@sideway/pinpoint': 2.0.0 '@hapi/tlds': 1.0.1
'@hapi/topo': 6.0.1
/js-tokens/4.0.0: /js-tokens/4.0.0:
resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==} resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==}
@ -8186,7 +8192,7 @@ packages:
hasBin: true hasBin: true
dependencies: dependencies:
axios: 0.25.0 axios: 0.25.0
joi: 17.7.1 joi: 17.8.1
lodash: 4.17.21 lodash: 4.17.21
minimist: 1.2.8 minimist: 1.2.8
rxjs: 7.8.0 rxjs: 7.8.0

View File

@ -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 = { 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 module.exports = sidebars
/*
tutorialSidebar: [
'intro',
'hello',
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
},
],
*/
};
module.exports = sidebars;