Skip to content

My personal website featuring info about me and a repo list. Blog soon!

License

Notifications You must be signed in to change notification settings

lilykiwi/lilykiwi.xyz

Repository files navigation

lilykiwi.xyz

View the live site »


Table of Contents

  1. Usage
  2. License
  3. Contributing

This is the source code for my personal website, lilykiwi.xyz. It's written in TypeScript and SCSS, using Rollup to bundle the code and Preact to render it. It's currently a static site, although I plan on adding a backend in the future for things like a blog and contact form.

Usage

This project uses Yarn for package management. It is required (I think?) to use yarn berry, which can be set up by running yarn set version berry or yarn set version latest.

To get intellisense working in vscode, you should run: yarn dlx @yarnpkg/sdks vscode

This project includes .pnp.cjs and .pnp.loader.mjs, the alternative to node_modules, so you don't need to install with yarn, you can skip straight to:

  • yarn run watch - watches src/** for changes and rebuilds on change. might be buggy (I'm working on it!!)
  • yarn run build - builds the site to output/
  • yarn run doc - generates Markdown documentation in docs/ using TypeDoc

License

This project is licensed under the MIT license. See the License file for more information.

Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change. This is a personal site so I may not accept all changes, but I will try to be as open as possible. If you want to use this code for your own site, feel free to fork it and modify it to your liking. Additionally, a boilerplate version of this site is available here, which you can use as a starting point for your own site using this same build process.

About

My personal website featuring info about me and a repo list. Blog soon!

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published