noway.moe/README.md

42 lines
1.3 KiB
Markdown
Raw Normal View History

2023-12-26 22:09:20 -07:00
# My Personal Website!
2023-12-25 20:01:37 -07:00
2023-12-26 22:09:20 -07:00
The codebase for my personal website, which you can [visit
here](https://dev.noway.moe)!
2023-12-25 20:01:37 -07:00
2023-12-26 22:09:20 -07:00
Written using [Astro.js](https://astro.build/) as the main framework, with
2023-12-26 22:14:41 -07:00
[Tailwind CSS](https://tailwindcss.com/). MDX rendering and syntax highlighting
provided by [remark.js](https://github.com/remarkjs).
2023-12-25 20:01:37 -07:00
2023-12-31 18:55:24 -07:00
![Front page of
2023-12-31 19:10:58 -07:00
noway.moe](https://cdn.discordapp.com/attachments/436012664003624970/1191201280933245108/screenshot_shm.png)
2023-12-31 18:55:24 -07:00
2023-12-26 22:09:20 -07:00
### Licence
2023-12-25 20:01:37 -07:00
2023-12-26 22:09:20 -07:00
Feel free to fork this code and use it for your website! No need to credit me.
2023-12-25 20:01:37 -07:00
2023-12-26 22:16:06 -07:00
This code is licensed under AGPL, meaning that you must open source any forks of
this code. That way everyone can benefit from our collective efforts!
2023-12-25 20:01:37 -07:00
2023-12-26 22:09:20 -07:00
### Building
2023-12-25 20:01:37 -07:00
2023-12-26 22:09:20 -07:00
If you're interested in building this code, do the following:
2023-12-25 20:01:37 -07:00
2023-12-26 22:09:20 -07:00
```bash
git clone https://git.mami2.moe/akemi/noway.moe
cd noway.moe
npm install
npm run dev
2023-12-25 20:01:37 -07:00
2023-12-26 22:09:20 -07:00
# To view the compiled version
npm run preview
2023-12-25 20:01:37 -07:00
2023-12-26 22:09:20 -07:00
# Once you're ready to publish
npm run build
```
2023-12-25 20:01:37 -07:00
2023-12-26 22:09:20 -07:00
I use [Cloudflare Pages](https://pages.cloudflare.com) for hosting. It's free
for static sites, but there are many other options to consider including
[Vercel](https://vercel.com/), [Github](https://pages.github.com), and
[Netlify](https://www.netlify.com) all of which are also free and fast for
static webpages! Live on the edge, pick one you haven't tried!