leilukin-site/README.md

# Leilukin's Hub

Source code of my hobby website, [Leilukin's Hub](https://leilukin.com/). Built with [Eleventy](https://www.11ty.dev/).

Deployed [Netlify](https://www.netlify.com/) and [Neocities](https://neocities.org/). The [deploy-to-neocities](https://github.com/bcomnes/deploy-to-neocities) GitHub action is used to deploy this site to Neocities.

Originally, this website was hosted on Neocities exclusively. While I am still deploying this site to Neocities, visiting `leilukin.neocities.org` will redirect you to `leilukin.com`. That said, if you also have a Neocities account, you can still follow me through [my Neocities profile](https://neocities.org/site/leilukin).

## 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
- [@zachleat/details-utils](https://www.npmjs.com/package/@zachleat/details-utils)

### Eleventy Community Plugins
- [@11tyrocks/eleventy-plugin-emoji-readtime](https://www.npmjs.com/package/@11tyrocks/eleventy-plugin-emoji-readtime)
- [eleventy-plugin-embed-everything](https://www.npmjs.com/package/eleventy-plugin-embed-everything)
- [eleventy-plugin-metagen](https://www.npmjs.com/package/eleventy-plugin-metagen)
- [@uncenter/eleventy-plugin-toc](https://www.npmjs.com/package/@uncenter/eleventy-plugin-toc)

### markdown-it plugins
- [markdown-it-anchor](https://www.npmjs.com/package/markdown-it-anchor)
- [markdown-it-attribution](https://www.npmjs.com/package/markdown-it-attribution)
- [markdown-it-attrs](https://www.npmjs.com/package/markdown-it-attrs)
- [markdown-it-bracketed-spans](https://www.npmjs.com/package/markdown-it-bracketed-spans)
- [markdown-it-deflist](https://www.npmjs.com/package/markdown-it-deflist)
- [markdown-it-footnote](https://www.npmjs.com/package/markdown-it-footnote)

## Self-hosted Assets
- [Lexend](https://www.lexend.com/) font family
- [Intel One Mono](https://www.intel.com/content/www/us/en/company-overview/one-monospace-font.html) typeface
- [Font Awesome](https://fontawesome.com/)

## Run Locally
Recommended JavaScript runtime: [Bun](https://bun.sh).

1. Clone this repository locally
    ```
    git clone https://github.com/helenclx/Neocities-Leilukin.git
    ```
1. Install dependencies
    ```
    bun install
    ```
1. Run the project
    ```
    bun run start
    ```
1. Open http://localhost:8080/ in your browser
Add information about dependencies and self-hosted assets 2024-04-27 07:36:01 +00:00			`# Leilukin's Hub`
Install Eleventy 2024-04-06 03:57:28 +00:00
Update about information about the site's hosting on Netlify and Neocities 2024-06-01 00:27:40 +00:00			`Source code of my hobby website, [Leilukin's Hub](https://leilukin.com/). Built with [Eleventy](https://www.11ty.dev/).`

			`Deployed [Netlify](https://www.netlify.com/) and [Neocities](https://neocities.org/). The [deploy-to-neocities](https://github.com/bcomnes/deploy-to-neocities) GitHub action is used to deploy this site to Neocities.`
Install Eleventy 2024-04-06 03:57:28 +00:00
Update Read Me file about the site's deployment to Netlify and Neocities 2024-06-01 01:02:14 +00:00			Originally, this website was hosted on Neocities exclusively. While I am still deploying this site to Neocities, visiting `leilukin.neocities.org` will redirect you to `leilukin.com`. That said, if you also have a Neocities account, you can still follow me through [my Neocities profile](https://neocities.org/site/leilukin).

Add information about dependencies and self-hosted assets 2024-04-27 07:36:01 +00:00			`## 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`
Use NPM package full name for dependencies 2024-05-26 05:44:36 +00:00			`- [@zachleat/details-utils](https://www.npmjs.com/package/@zachleat/details-utils)`
Categorise plugins 2024-05-22 07:29:59 +00:00
			`### Eleventy Community Plugins`
Updatelist of Eleventy community plugins used for the site 2024-05-26 05:42:55 +00:00			`- [@11tyrocks/eleventy-plugin-emoji-readtime](https://www.npmjs.com/package/@11tyrocks/eleventy-plugin-emoji-readtime)`
Add information about dependencies and self-hosted assets 2024-04-27 07:36:01 +00:00			`- [eleventy-plugin-embed-everything](https://www.npmjs.com/package/eleventy-plugin-embed-everything)`
Categorise plugins 2024-05-22 07:29:59 +00:00			`- [eleventy-plugin-metagen](https://www.npmjs.com/package/eleventy-plugin-metagen)`
Updatelist of Eleventy community plugins used for the site 2024-05-26 05:42:55 +00:00			`- [@uncenter/eleventy-plugin-toc](https://www.npmjs.com/package/@uncenter/eleventy-plugin-toc)`
Categorise plugins 2024-05-22 07:29:59 +00:00
			`### markdown-it plugins`
Add information about dependencies and self-hosted assets 2024-04-27 07:36:01 +00:00			`- [markdown-it-anchor](https://www.npmjs.com/package/markdown-it-anchor)`
Install markdown-it-attribution plugin 2024-05-09 12:12:22 +00:00			`- [markdown-it-attribution](https://www.npmjs.com/package/markdown-it-attribution)`
Change link of markdown-it-attrs 2024-05-06 11:35:37 +00:00			`- [markdown-it-attrs](https://www.npmjs.com/package/markdown-it-attrs)`
Install markdown-it-bracketed-spans plugin 2024-05-06 12:15:51 +00:00			`- [markdown-it-bracketed-spans](https://www.npmjs.com/package/markdown-it-bracketed-spans)`
Add markdown-it-footnote to dependencies list 2024-05-17 17:29:32 +00:00			`- [markdown-it-deflist](https://www.npmjs.com/package/markdown-it-deflist)`
			`- [markdown-it-footnote](https://www.npmjs.com/package/markdown-it-footnote)`
Install Eleventy 2024-04-06 03:57:28 +00:00
Add information about dependencies and self-hosted assets 2024-04-27 07:36:01 +00:00			`## Self-hosted Assets`
Update font family info 2024-05-20 05:27:35 +00:00			`- [Lexend](https://www.lexend.com/) font family`
Add Intel One Mono typeface to list of self-hosted assets 2024-05-22 07:27:53 +00:00			`- [Intel One Mono](https://www.intel.com/content/www/us/en/company-overview/one-monospace-font.html) typeface`
Add information about dependencies and self-hosted assets 2024-04-27 07:36:01 +00:00			`- [Font Awesome](https://fontawesome.com/)`
Install Eleventy 2024-04-06 03:57:28 +00:00
Add information about dependencies and self-hosted assets 2024-04-27 07:36:01 +00:00			`## Run Locally`
Format instructions to run the prooject locally 2024-05-22 10:09:57 +00:00			`Recommended JavaScript runtime: [Bun](https://bun.sh).`

Add information about dependencies and self-hosted assets 2024-04-27 07:36:01 +00:00			`1. Clone this repository locally`
Format instructions to run the prooject locally 2024-05-22 10:09:57 +00:00			```
			`git clone https://github.com/helenclx/Neocities-Leilukin.git`
			```
			`1. Install dependencies`
			```
			`bun install`
			```
			`1. Run the project`
			```
			`bun run start`
			```
			`1. Open http://localhost:8080/ in your browser`