mirror of
https://github.com/cupcakearmy/memoir.git
synced 2025-09-07 00:10:40 +00:00
Compare commits
34 Commits
5c05023784
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| c0f8de1f86 | |||
| 7864c38371 | |||
| d17a565130 | |||
| 12f5d932b1 | |||
|
306eddf4bf | ||
| ae86edf961 | |||
|
|
91d15569a6 | ||
| d7eaf2a06a | |||
| a509e476f1 | |||
| aa9d0798e3 | |||
| 4550b301a1 | |||
| cdec1b86b8 | |||
| 42dcee4dc0 | |||
| b0cb5dca72 | |||
| 914c29c087 | |||
| 5d333bee79 | |||
|
|
ea0b16e8c1 | ||
| 3e69437018 | |||
| eb8815a6c2 | |||
|
|
eaac32317f | ||
| 48c8dc4ad9 | |||
| dcef283b92 | |||
| 768bbce8b3 | |||
| 9a5d3ca87d | |||
| 0f172b5c61 | |||
| eb63b57ad4 | |||
| 1f04e83a3d | |||
| 0a977a0b3d | |||
| a4f2d2b1dd | |||
| 2042ca97c1 | |||
| 074ad94d7e | |||
| 91b041c5d9 | |||
| 65b24be322 | |||
| 237a6cf548 |
17
.github/actions/build/action.yaml
vendored
17
.github/actions/build/action.yaml
vendored
@@ -1,17 +0,0 @@
|
||||
name: "Build"
|
||||
description: "Install deps and build docs"
|
||||
|
||||
runs:
|
||||
using: "composite"
|
||||
steps:
|
||||
- uses: pnpm/action-setup@v2
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version-file: .nvmrc
|
||||
cache: "pnpm"
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
shell: bash
|
||||
- name: Build
|
||||
run: pnpm build
|
||||
shell: bash
|
||||
35
.github/workflows/preview.yaml
vendored
35
.github/workflows/preview.yaml
vendored
@@ -1,35 +0,0 @@
|
||||
name: Docs
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- uses: ./.github/actions/build
|
||||
|
||||
- uses: actions/configure-pages@v3
|
||||
- uses: actions/upload-pages-artifact@v1
|
||||
with:
|
||||
path: "./out"
|
||||
- id: deployment
|
||||
uses: actions/deploy-pages@v1
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,4 +1,3 @@
|
||||
node_modules
|
||||
|
||||
.next
|
||||
out
|
||||
public
|
||||
27
app/[[...mdxPath]]/page.tsx
Normal file
27
app/[[...mdxPath]]/page.tsx
Normal file
@@ -0,0 +1,27 @@
|
||||
import { generateStaticParamsFor, importPage } from "nextra/pages";
|
||||
import { useMDXComponents as getMDXComponents } from "../../mdx-components";
|
||||
|
||||
export const generateStaticParams = generateStaticParamsFor("mdxPath");
|
||||
|
||||
export async function generateMetadata(props) {
|
||||
const params = await props.params;
|
||||
const { metadata } = await importPage(params.mdxPath);
|
||||
return metadata;
|
||||
}
|
||||
|
||||
const Wrapper = getMDXComponents().wrapper;
|
||||
|
||||
export default async function Page(props) {
|
||||
const params = await props.params;
|
||||
const {
|
||||
default: MDXContent,
|
||||
toc,
|
||||
metadata,
|
||||
sourceCode,
|
||||
} = await importPage(params.mdxPath);
|
||||
return (
|
||||
<Wrapper toc={toc} metadata={metadata} sourceCode={sourceCode}>
|
||||
<MDXContent {...props} params={params} />
|
||||
</Wrapper>
|
||||
);
|
||||
}
|
||||
57
app/layout.tsx
Normal file
57
app/layout.tsx
Normal file
@@ -0,0 +1,57 @@
|
||||
import { Footer, Layout, Navbar } from "nextra-theme-docs";
|
||||
import { Banner, Head } from "nextra/components";
|
||||
import { getPageMap } from "nextra/page-map";
|
||||
import "nextra-theme-docs/style.css";
|
||||
|
||||
export const metadata = {
|
||||
// Define your metadata here
|
||||
// For more information on metadata API, see: https://nextjs.org/docs/app/building-your-application/optimizing/metadata
|
||||
};
|
||||
|
||||
const navbar = (
|
||||
<Navbar
|
||||
projectLink="https://github.com/cupcakearmy/memoir"
|
||||
logo={<b>Memoir</b>}
|
||||
/>
|
||||
);
|
||||
const footer = (
|
||||
<Footer>
|
||||
<span>
|
||||
MIT {new Date().getFullYear()} ©{" "}
|
||||
<a href="https://github.com/cupcakearmy" target="_blank">
|
||||
cupcakearmy
|
||||
</a>
|
||||
.
|
||||
</span>
|
||||
</Footer>
|
||||
);
|
||||
|
||||
export default async function RootLayout({ children }) {
|
||||
return (
|
||||
<html lang="en" dir="ltr" suppressHydrationWarning>
|
||||
<Head>
|
||||
<script
|
||||
defer
|
||||
src="https://spectare.nicco.io//unicorn.js"
|
||||
data-website-id="4aecaa6f-1e68-4a21-960a-8ff5aaa6599a"
|
||||
></script>
|
||||
</Head>
|
||||
<body>
|
||||
<Layout
|
||||
sidebar={{
|
||||
defaultMenuCollapseLevel: 1,
|
||||
}}
|
||||
feedback={{
|
||||
content: "Question? An error? Give feedback →",
|
||||
}}
|
||||
navbar={navbar}
|
||||
pageMap={await getPageMap()}
|
||||
docsRepositoryBase="https://github.com/cupcakearmy/memoir/blob/main"
|
||||
footer={footer}
|
||||
>
|
||||
{children}
|
||||
</Layout>
|
||||
</body>
|
||||
</html>
|
||||
);
|
||||
}
|
||||
8
content/_meta.ts
Normal file
8
content/_meta.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
export default {
|
||||
index: 'Intro',
|
||||
cli: 'CLI',
|
||||
git: 'Git',
|
||||
dev_ops: 'Dev Ops',
|
||||
latex: 'LaTeX',
|
||||
web_dev: 'Web Development',
|
||||
}
|
||||
21
content/admin/windows.md
Normal file
21
content/admin/windows.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
tags:
|
||||
- windows
|
||||
- administration
|
||||
---
|
||||
|
||||
# Windows
|
||||
|
||||
|
||||
## List of tools
|
||||
|
||||
- [De-Bloat](https://github.com/Raphire/Win11Debloat)
|
||||
- [Microsoft Activation Scripts](https://github.com/massgravel/Microsoft-Activation-Scripts)
|
||||
- [Uniget UI](https://github.com/marticliment/UnigetUI)
|
||||
|
||||
|
||||
## Utils
|
||||
|
||||
### Add local user
|
||||
|
||||
`Win + R` then `netplwiz`
|
||||
7
content/cli/delete-empty-directories.md
Normal file
7
content/cli/delete-empty-directories.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Delete empty directories
|
||||
|
||||
```bash
|
||||
find . -type d -empty -delete
|
||||
```
|
||||
|
||||
This recursively finds and deletes empty directory.
|
||||
23
content/cli/format-drive.md
Normal file
23
content/cli/format-drive.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
tags:
|
||||
- cli
|
||||
- macos
|
||||
- format
|
||||
---
|
||||
|
||||
# Format a Drive
|
||||
|
||||
## macOS
|
||||
|
||||
Some times Disk Utility cannot format a whole drive for some reason.
|
||||
|
||||
```
|
||||
# Check devices
|
||||
diskutil list
|
||||
|
||||
# To exfat
|
||||
diskutil eraseDisk EXFAT "NAME" GPT /dev/diskN
|
||||
|
||||
# To fat32, with mbr
|
||||
diskutil eraseDisk FAT32 "NAME" MBR /dev/diskN
|
||||
```
|
||||
4
content/dev_ops/_meta.ts
Normal file
4
content/dev_ops/_meta.ts
Normal file
@@ -0,0 +1,4 @@
|
||||
export default {
|
||||
'github-actions': 'Github Actions',
|
||||
hosting: 'Hosting',
|
||||
}
|
||||
@@ -22,15 +22,15 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v2
|
||||
uses: docker/setup-qemu-action@v3
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v2
|
||||
uses: docker/setup-buildx-action@v3
|
||||
with:
|
||||
install: true
|
||||
|
||||
- name: Docker Labels
|
||||
id: meta
|
||||
uses: docker/metadata-action@v4
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: |
|
||||
foo/bar
|
||||
@@ -43,19 +43,19 @@ jobs:
|
||||
type=semver,pattern={{major}}
|
||||
|
||||
- name: Log in to Docker Hub
|
||||
uses: docker/login-action@v2
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_TOKEN }}
|
||||
- name: Log in to the Container registry
|
||||
uses: docker/login-action@v2
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v3
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
14
content/dev_ops/hosting/docker-registry.md
Normal file
14
content/dev_ops/hosting/docker-registry.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
tags:
|
||||
- docker registry
|
||||
- hosting
|
||||
- authentication
|
||||
---
|
||||
|
||||
# Setup you own authenticated Docker Registry
|
||||
|
||||
## Resources
|
||||
|
||||
- https://earthly.dev/blog/private-docker-registry/
|
||||
- https://www.digitalocean.com/community/tutorials/how-to-set-up-a-private-docker-registry-on-ubuntu-20-04
|
||||
- https://github.com/docker/get-involved/blob/90c9470fd66c9318fec9c6f0914cb70fa87b9bf9/content/en/docs/CommunityLeaders/EventHandbooks/Docker101/registry/_index.md?plain=1#L203
|
||||
17
content/git/clean.md
Normal file
17
content/git/clean.md
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
tags:
|
||||
- git
|
||||
- clean
|
||||
- gitignore
|
||||
- delete
|
||||
---
|
||||
|
||||
# Delete all files mentioned by `.gitignore`
|
||||
|
||||
This command is useful if you want to reset a repository to it's checked out state.
|
||||
|
||||
```bash
|
||||
git clean -Xdf
|
||||
```
|
||||
|
||||
[Original SO Link](https://unix.stackexchange.com/a/542735)
|
||||
20
content/git/remove-merged-branch.md
Normal file
20
content/git/remove-merged-branch.md
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
tags:
|
||||
- git
|
||||
- branch
|
||||
- clean
|
||||
- delete
|
||||
---
|
||||
|
||||
# Delete all local branches that are already merged.
|
||||
|
||||
This command is useful if you have a buch of local branches that you don't need anymore.
|
||||
|
||||
```bash
|
||||
git branch --merged | grep -v \* | xargs git branch -D
|
||||
```
|
||||
|
||||
[Original SO Link](https://stackoverflow.com/a/10610669)
|
||||
|
||||
|
||||
|
||||
9
content/git/remove-secrets.md
Normal file
9
content/git/remove-secrets.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Remove secrets after being pushed
|
||||
|
||||
If you accidentally pushed a secret or some file that should not be publicly available in your git repo, there are a few ways. My personal fav is [BFG](https://rtyley.github.io/bfg-repo-cleaner/).
|
||||
|
||||
> `--no-blob-protection` also modifies you latest commit, by default that is turned off.
|
||||
|
||||
```bash
|
||||
bfg -D "*.txt" --no-blob-protection
|
||||
```
|
||||
@@ -3,5 +3,9 @@
|
||||
How to reset files from another branch.
|
||||
|
||||
```sh
|
||||
# New way
|
||||
git restore my/file.md
|
||||
|
||||
# Old way
|
||||
git checkout origin/HEAD -- my/file.md
|
||||
```
|
||||
16
content/git/revert-commit.md
Normal file
16
content/git/revert-commit.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Revert branch to commit
|
||||
|
||||
Revert a branch to a certain commit, discarding newer ones.
|
||||
|
||||
```bash
|
||||
# Specific commit
|
||||
git reset --hard a1d6424
|
||||
|
||||
# Commits back
|
||||
git reset --hard HEAD@{3}
|
||||
```
|
||||
|
||||
```bash
|
||||
# Push
|
||||
git push -f
|
||||
```
|
||||
82
content/web_dev/tailwind_theme.md
Normal file
82
content/web_dev/tailwind_theme.md
Normal file
@@ -0,0 +1,82 @@
|
||||
---
|
||||
tags:
|
||||
- tailwind
|
||||
- theme
|
||||
- css variables
|
||||
- dark mode
|
||||
---
|
||||
|
||||
# Tailwind themes with CSS Variables
|
||||
|
||||
There are many tailwind theme plugins, tried few and landed on`tailwindcss-themer`.
|
||||
|
||||
## Setup
|
||||
|
||||
Two files are required:
|
||||
|
||||
1. `pnpm i -D tailwindcss-themer`
|
||||
1. `tailwind.config.js`
|
||||
1. `app.postcss`
|
||||
|
||||
> Technically, we don't need to use CSS variables, but I like to, as I can export them automatically from Figma, or whatever design tool. Without CSS Variables, you could just define the colors in `tailwind.config.js` without touching css files.
|
||||
|
||||
```js
|
||||
// tailwind.config.js
|
||||
|
||||
const themer = require('tailwindcss-themer')
|
||||
|
||||
/** @type {import('tailwindcss').Config}*/
|
||||
const config = {
|
||||
theme: {
|
||||
// ...
|
||||
},
|
||||
|
||||
plugins: [
|
||||
themer({
|
||||
defaultTheme: {
|
||||
extend: {
|
||||
colors: {
|
||||
primary: 'var(--colors-cyan-500)',
|
||||
secondary: 'var(--colors-yellow-500)',
|
||||
surface: 'var(--colors-gray-100)',
|
||||
text: 'var(--colors-gray-900)',
|
||||
},
|
||||
},
|
||||
},
|
||||
themes: [
|
||||
{
|
||||
name: 'darker',
|
||||
mediaQuery: '@media (prefers-color-scheme: dark)',
|
||||
extend: {
|
||||
colors: {
|
||||
primary: 'var(--colors-cyan-700)',
|
||||
secondary: 'var(--colors-yellow-500)',
|
||||
surface: 'var(--colors-gray-900)',
|
||||
text: 'var(--colors-gray-100)',
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
],
|
||||
}
|
||||
|
||||
module.exports = config
|
||||
```
|
||||
|
||||
```css
|
||||
/* app.postcss */
|
||||
|
||||
@tailwind base;
|
||||
@tailwind components;
|
||||
@tailwind utilities;
|
||||
|
||||
:root {
|
||||
/* colors */
|
||||
--colors-cyan-500: rgb(164, 189, 245);
|
||||
--colors-cyan-700: #0d398c;
|
||||
--colors-gray-100: rgb(255, 255, 255);
|
||||
--colors-gray-900: rgb(1, 1, 1);
|
||||
--colors-yellow-500: rgb(233, 246, 82);
|
||||
}
|
||||
```
|
||||
12
mdx-components.ts
Normal file
12
mdx-components.ts
Normal file
@@ -0,0 +1,12 @@
|
||||
import { useMDXComponents as getThemeComponents } from "nextra-theme-docs"; // nextra-theme-blog or your custom theme
|
||||
|
||||
// Get the default MDX components
|
||||
const themeComponents = getThemeComponents();
|
||||
|
||||
// Merge components
|
||||
export function useMDXComponents(components = {}) {
|
||||
return {
|
||||
...themeComponents,
|
||||
...components,
|
||||
};
|
||||
}
|
||||
6
next-env.d.ts
vendored
Normal file
6
next-env.d.ts
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
/// <reference types="next" />
|
||||
/// <reference types="next/image-types/global" />
|
||||
/// <reference path="./.next/types/routes.d.ts" />
|
||||
|
||||
// NOTE: This file should not be edited
|
||||
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.
|
||||
@@ -1,11 +0,0 @@
|
||||
const withNextra = require('nextra')({
|
||||
theme: 'nextra-theme-docs',
|
||||
themeConfig: './theme.config.jsx',
|
||||
})
|
||||
|
||||
module.exports = {
|
||||
...withNextra(),
|
||||
images: {
|
||||
unoptimized: true,
|
||||
},
|
||||
}
|
||||
5
next.config.mjs
Normal file
5
next.config.mjs
Normal file
@@ -0,0 +1,5 @@
|
||||
import nextra from "nextra";
|
||||
|
||||
const withNextra = nextra({});
|
||||
|
||||
export default withNextra({});
|
||||
25
package.json
25
package.json
@@ -1,16 +1,21 @@
|
||||
{
|
||||
"private": true,
|
||||
"license": "MIT",
|
||||
"packageManager": "pnpm@8.6.0",
|
||||
"scripts": {
|
||||
"dev": "next dev",
|
||||
"build": "next build && next export"
|
||||
"dev": "next",
|
||||
"build": "next build",
|
||||
"start": "next start",
|
||||
"postbuild": "pagefind --site .next/server/app --output-path public/_pagefind"
|
||||
},
|
||||
"dependencies": {
|
||||
"next": "^13.4.4",
|
||||
"nextra": "^2.6.2",
|
||||
"nextra-theme-docs": "^2.6.2",
|
||||
"react": "^18.2.0",
|
||||
"react-dom": "^18.2.0"
|
||||
"next": "^15.5.2",
|
||||
"nextra": "^4.4.0",
|
||||
"nextra-theme-docs": "^4.4.0",
|
||||
"react": "^19.1.1",
|
||||
"react-dom": "^19.1.1"
|
||||
},
|
||||
"packageManager": "pnpm@10.15.1",
|
||||
"devDependencies": {
|
||||
"@types/node": "24.3.1",
|
||||
"@types/react": "19.1.12",
|
||||
"pagefind": "^1.4.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
export default function App({ Component, pageProps }) {
|
||||
return <Component {...pageProps} />
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"index": "Intro",
|
||||
"cli": "CLI",
|
||||
"git": "Git",
|
||||
"dev_ops": "Dev Ops",
|
||||
"latex": "LaTeX"
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"github-actions": "Github Actions",
|
||||
"hosting": "Hosting"
|
||||
}
|
||||
5955
pnpm-lock.yaml
generated
5955
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
2
pnpm-workspace.yaml
Normal file
2
pnpm-workspace.yaml
Normal file
@@ -0,0 +1,2 @@
|
||||
onlyBuiltDependencies:
|
||||
- sharp
|
||||
@@ -1,24 +0,0 @@
|
||||
export default {
|
||||
logo: <span>Memoir</span>,
|
||||
docsRepositoryBase: 'https://github.com/cupcakearmy/memoir/blob/main',
|
||||
project: {
|
||||
link: 'https://github.com/cupcakearmy/memoir',
|
||||
},
|
||||
sidebar: {
|
||||
defaultMenuCollapseLevel: 1,
|
||||
},
|
||||
feedback: {
|
||||
content: 'Question? An error? Give feedback →',
|
||||
},
|
||||
footer: {
|
||||
text: (
|
||||
<span>
|
||||
MIT {new Date().getFullYear()} ©{' '}
|
||||
<a href="https://github.com/cupcakearmy" target="_blank">
|
||||
cupcakearmy
|
||||
</a>
|
||||
.
|
||||
</span>
|
||||
),
|
||||
},
|
||||
}
|
||||
24
tsconfig.json
Normal file
24
tsconfig.json
Normal file
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2017",
|
||||
"lib": ["dom", "dom.iterable", "esnext"],
|
||||
"allowJs": true,
|
||||
"skipLibCheck": true,
|
||||
"strict": false,
|
||||
"noEmit": true,
|
||||
"incremental": true,
|
||||
"module": "esnext",
|
||||
"esModuleInterop": true,
|
||||
"moduleResolution": "bundler",
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"jsx": "preserve",
|
||||
"plugins": [
|
||||
{
|
||||
"name": "next"
|
||||
}
|
||||
]
|
||||
},
|
||||
"include": ["next-env.d.ts", ".next/types/**/*.ts", "**/*.ts", "**/*.tsx"],
|
||||
"exclude": ["node_modules"]
|
||||
}
|
||||
Reference in New Issue
Block a user