Add information about dependencies and self-hosted assets
This commit is contained in:
parent
bfc0d417e5
commit
e29af4e638
35
README.md
35
README.md
|
@ -1,15 +1,34 @@
|
||||||
# neocities-leilukin
|
# Leilukin's Hub
|
||||||
|
|
||||||
To install dependencies:
|
Source code of my personal and hobby website, [Leilukin's Hub](https://leilukin.neocities.org/), hosted on [Neocities](https://neocities.org/).
|
||||||
|
|
||||||
```bash
|
## Dependencies
|
||||||
|
- [Eleventy](https://www.11ty.dev/)
|
||||||
|
- Eleventy's official [RSS](https://www.11ty.dev/docs/plugins/rss/) plugin
|
||||||
|
- Eleventy's official [Navigation](https://www.11ty.dev/docs/plugins/navigation/) plugin
|
||||||
|
- [Emoji Read Time Eleventy Plugin](https://11ty.rocks/#plugin-emoji-read-time)
|
||||||
|
- [eleventy-plugin-metagen](https://www.npmjs.com/package/eleventy-plugin-metagen)
|
||||||
|
- [eleventy-plugin-embed-everything](https://www.npmjs.com/package/eleventy-plugin-embed-everything)
|
||||||
|
- [markdown-it-anchor](https://www.npmjs.com/package/markdown-it-anchor)
|
||||||
|
- [Table of Contents (nesting) Eleventy Plugin](https://www.npmjs.com/package/eleventy-plugin-nesting-toc)
|
||||||
|
|
||||||
|
## Self-hosted Assets
|
||||||
|
- [Noto Sans](https://fonts.google.com/noto/specimen/Noto%20Sans) font family
|
||||||
|
- [Font Awesome](https://fontawesome.com/)
|
||||||
|
|
||||||
|
## Run Locally
|
||||||
|
1. Clone this repository locally
|
||||||
|
```
|
||||||
|
git clone https://github.com/helenclx/Neocities-Leilukin.git
|
||||||
|
```
|
||||||
|
2. Install dependencies
|
||||||
|
```
|
||||||
bun install
|
bun install
|
||||||
```
|
```
|
||||||
|
3. Run the project
|
||||||
To run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
bun run index.ts
|
|
||||||
```
|
```
|
||||||
|
bun run start
|
||||||
|
```
|
||||||
|
4. Open http://localhost:8080/ in your browser
|
||||||
|
|
||||||
This project was created using `bun init` in bun v1.1.0. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
|
This project was created using `bun init` in bun v1.1.0. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
|
||||||
|
|
Loading…
Reference in New Issue