Skip to content

Commit

Permalink
docs: enhance readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AshGw committed Jun 15, 2024
1 parent 38299bb commit f931421
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 2 deletions.
42 changes: 40 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,47 @@
### Setup

```shell

g cl [email protected]:AshGw/ashwg.me.git && ashgw.me && g ck -b dev && j s && e .

```

### Made W/
I [alias](https://github.com/ashgw/dotfiles) everything.

### Made w/

React & Next.

### Styling

Plain CSS is used for the base palette and theme, with Tailwind added for convenience. No component libraries nor templates were used, even the nav and hamburger menu, everything is manual.

I initially used ShadCN and NextUI for convenience, but I changed it since I wanted to maintain a unique and personal aesthetic rather than having the site look like everyone else's.

### Animations

Mostly Framer, but some GSAP too, with some custom animations here and there.

### Content

Rendered with MDX, S/O [next-mdx-remote](https://github.com/hashicorp/next-mdx-remote)

### Tested w/

Playwright & Jest.

### Deployments

Initially on Vercel, then DigitalOcean, then Vercel again, though considering AWS due to occasional Vercel issues.

### Other

Other tools were used to automate and glue everything together, too many to mention.

### State

Currently undocumented and unfactored. I'll address this upon receipt of an [issue](https://github.com/ashgw/ashgw.me/issues).

### License

ReactJS w/ NextJS, Style palette base with plain CSS, Tailwind for convenience, GSAP & Framer for animations, MDX for content, and many other tools to automate and glue everything together.
No plagiarism, that's it.
10 changes: 10 additions & 0 deletions src/app/components/reusables/code/code-block.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -683,6 +683,16 @@ import CopyButton from './copy-code';

// react-syntax-highlighter has no types

/* eslint-disable */
// @ts-nocheck

// react-syntax-highlighter has no types

/* eslint-disable */
// @ts-nocheck

// react-syntax-highlighter has no types

/* eslint-disable */
// @ts-nocheck
SyntaxHighlighter.registerLanguage('rust', rust);
Expand Down

0 comments on commit f931421

Please sign in to comment.