-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
49 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# [`vivsha.ws`](https://vivsha.ws) | ||
|
||
This is my website. It's a static site built with React. I use it for personal details and blogging. | ||
|
||
## Up and running | ||
|
||
```sh | ||
yarn | ||
yarn dev | ||
``` | ||
|
||
## Deployment | ||
|
||
`vivsha.ws` is a fully static app. It's deployed [via this GitHub Action](./.github/workflows/publish.yml) to GitHub Pages. | ||
|
||
## Repo structure | ||
|
||
[`./posts`](./posts) contains the posts themselves. I prefer for them to live outside the code in a separate top-level folder, and to be as close to standard markdown as possible, for a distraction-free writing environment. | ||
|
||
As for the JavaScript, the code is split into several packages using Yarn workspaces. | ||
|
||
- [`./apps/vivsha.ws`](./apps/vivsha.ws) contains the Next.js app for the site. | ||
- [`./packages/viriditas`](./packages/viriditas) contains (the bones of) Viriditas, the design system I am assembling to structure this site. | ||
- [`./packages/mdx`](./packages/mdx) contains a small library of prebuilt MDX components using the Viriditas styles. | ||
|
||
## Why `vivsha.ws`? | ||
|
||
I wanted `vivsh.aw` but that proved annoying, so I settled for `vivsha.ws`. Read it like: "vivshaw's", as in "vivshaw's webbed sight". | ||
|
||
## If it lives at `vivsha.ws`, why does it live in a repo called `vivshaw.github.io/`? | ||
|
||
A few reasons, both related to the requirements for [:](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites) | ||
|
||
- I used to host my blog at that URL, and I would like it to continue working, with a redirect to my new URL. | ||
- I'd prefer _all_ my GitHub Pages to live under `vivsha.ws`. | ||
|
||
The easiest way to accomplish these things is by setting a custom domain for my user site. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,3 @@ | ||
# Example app with MDX | ||
# @vivshaw/vivsha.ws | ||
|
||
This example shows using [MDX](https://github.com/mdx-js/mdx) as top level pages for your next.js app. | ||
|
||
## Deploy your own | ||
|
||
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-mdx) | ||
|
||
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-mdx&project-name=with-mdx&repository-name=with-mdx) | ||
|
||
## How to use | ||
|
||
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example: | ||
|
||
```bash | ||
npx create-next-app --example with-mdx with-mdx-app | ||
``` | ||
|
||
```bash | ||
yarn create next-app --example with-mdx with-mdx-app | ||
``` | ||
|
||
```bash | ||
pnpm create next-app --example with-mdx with-mdx-app | ||
``` | ||
|
||
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)). | ||
This package contains the Next.js app that powers [`vivsha.ws`](https://vivsha.ws). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# @vivshaw/mdx | ||
|
||
This package is a library of prebuilt MDX components, styled with [Viriditas](../viriditas/). It is fully static and uses no runtime stylesheets or client React, so it's appropriate for use in server components. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# @vivshaw/viriditas | ||
|
||
This package contains (the bones of) the design system used to style [vivsha.ws](https://vivsha.ws). It's built with [Vanilla Extract](https://vanilla-extract.style/), and uses no runtime stylesheets. The library itself does not use client React and is fully appropriate for React Server Components, although a Context is provided for cases where you _do_ want to access theme values dynamically at runtime. |