Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AlynxZhou/hikaru
A static site generator that generates routes based on directories naturally.
https://github.com/AlynxZhou/hikaru
Last synced: about 2 months ago
JSON representation
A static site generator that generates routes based on directories naturally.
- Host: GitHub
- URL: https://github.com/AlynxZhou/hikaru
- Owner: AlynxZhou
- License: apache-2.0
- Created: 2019-10-21T10:27:54.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T02:51:36.000Z (6 months ago)
- Last Synced: 2024-07-26T21:58:14.743Z (about 2 months ago)
- Language: JavaScript
- Size: 1.53 MB
- Stars: 18
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Hikaru
======
A static site generator that generates routes based on directories naturally.
-----------------------------------------------------------------------------
[](https://www.npmjs.com/package/hikarujs)
[](https://www.npmjs.com/package/hikarujs)
[](https://www.npmjs.com/package/hikarujs)
[](https://github.com/AlynxZhou/hikaru/blob/master/LICENSE)
# Install
Hikaru is a command line program (not a module) and you can install it from NPM, since Hikaru v1.14.0, it is recommended to install it locally in your site dir and run it with `npx`:
```
$ npm i -s hikarujs && npx hikaru i
```
**Hikaru works on Node.js v18.12.0 LTS or later.**
# Setup Site
```
$ mkdir hikaru-site && cd hikaru-site
$ npm install --save hikarujs hikaru-generator-feed hikaru-generator-sitemap hikaru-generator-search
$ npx hikaru init --debug
```
# Clone Theme
Using `hikaru-theme-aria` as example:
```
$ git clone https://github.com/AlynxZhou/hikaru-theme-aria.git themes/aria
```
Or if you want commit the whole site you can use submodule:
```
$ git submodule add https://github.com/AlynxZhou/hikaru-theme-aria.git themes/aria
```
# Edit Config
```
$ $EDITOR site-config.yaml
```
Set `themeDir` to `themes/aria`:
```yaml
themeDir: themes/aria
```
Copy theme config to site dir and edit it:
```
$ cp themes/aria/theme-config.yaml theme-config.yaml
$ $EDITOR theme-config.yaml
```
# Create Src File
## Edit File
```
$ $EDITOR srcs/my-first-post.md
```
## Add Front Matter
```yaml
---
title: My First Post
created: 2018-08-08T09:27:00
layout: post
---
```
## Add Content
```markdown
Some content...
# This is my first post!
```
# Start Live Server
```
$ npx hikaru serve --debug
```
# Build Static Files
```
$ npx hikaru build --debug
```
# Contribute
If you want to contribute, please follow my coding style.
Most things can be fixed by standardx and custom eslint rules, so please run `npm test` before commit, and use `npx standardx --fix bin/* hikaru/*.js tests/*.js` to fix most problems, and fix remaining problems that cannot pass tests manually.
I'll list personal flavors that cannot be handled by eslint here. If some things are not listed, follow existing code.
## Arrays, Objects or Sets, Maps
If we have some simple types and we want to exclude same elements, just use Set.
If we want a dictionary to store keys and values, and keys are not fixed, just use Map.
Otherwise, use Arrays and Objects, for example lists, queues or dictionaries that have fixed keys.
If we got parsed Objects and Arrays, for example options from YAML files or data from JSON files, don't convert them into Maps and Sets except we need to do other operations on them.
## `for...of`, `for...in`, `.forEach()`, `.map()`
If we are not only doing some operations to array elements but also caring about their return values, just use `.map()`.
If we just do some opeartions to array elements but not caring about return values, don't use `.map()`.
If we are iterating Objects, use `for...in`.
Otherwise, use `for...of`.
Never use `.forEach()` unless you cannot use `for...of`, they are almost the same and we learn `for` in the first coding lesson so why not `for`?
## `class` or `.prototype`
I just prefer `class`.
## Common JS or ES Module
I personally like Common JS, but more and more libraries use ES module, so use ES module.
# More
Docs:
Repo: [GitHub](https://github.com/AlynxZhou/hikaru/)
Default theme ARIA: [hikaru-theme-aria](https://github.com/AlynxZhou/hikaru-theme-aria/)
My blog built with Hikaru and ARIA: [喵's StackHarbor](https://sh.alynx.one/)
# License
[Apache-2.0](./LICENSE)