Contributing

If all you want to do is make a quick edit to a page, there is an “edit page” button at the bottom of every page that brings you to github. Make your edits, and open a PR.

Development

This website/documentation page was built with Starlight. You write markdown or mdx (markdown extended) and it turns into html.

1. Clone the repo

   git clone [email protected]:0xdeis/0xdeis.com.git

2. Install bun, a javascript package manager.

   From https://bun.sh/

   # Linux / MacOS
   curl -fsSL https://bun.sh/install | bash
   
   # Windows
   powershell -c "irm bun.sh/install.ps1 | iex"

3. Install dependencies

   bun install

4. Make a new branch

   git switch -c feat/...
   # or
   git switch -c fix/...

5. Start the dev server

   bun dev

   $ astro dev
   19:01:15 [types] Generated 1ms
   
    astro  v4.15.9 ready in 477 ms
   
   ┃ Local    http://localhost:4321/
   ┃ Network  use --host to expose
   
   19:01:15 watching for file changes...

6. Navigate to http://localhost:4321

7. Configure your editor.

   For neovim

   • https://morizbuesing.com/blog/mdx-support-in-nvchad/
   • https://www.reddit.com/r/neovim/comments/1ewwtok/has_anyone_figured_out_intellisense_in_mdx_files/

   For VSCode

   • https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx

8. Make some changes, commit, and push to start the review cycle.