diff --git a/README.md b/README.md index 7f62f89fd9250789ecd4968eec24a550ab288e14..662318c2d697e20d385bed7c326202c407741b72 100644 --- a/README.md +++ b/README.md @@ -21,17 +21,14 @@ Karzok uses npm,zola to dependency managment,rendering, scripts and plugins. 1. [Zola](https://www.getzola.org/documentation/getting-started/installation/) 2. [Node.js](https://nodejs.org/) +3. [rsync](https://rsync.samba.org) for your platform. ### Optional -1. [yj](https://github.com/sclevine/yj) - > for transfer toml file in yaml -2. [docker](https://docs.docker.com/engine/install/) +- [docker](https://docs.docker.com/engine/install/) > for packaging container -3. [rsync](https://rsync.samba.org/) - > A better copy and move ## Get Started @@ -81,7 +78,8 @@ i. development enviroment 1. Install node dependencies needed to work ```zsh -npm run gen # don't use npm install before that +npm ci +npm run gen ``` 2. Just run `zola serve` in the root path of the project @@ -103,10 +101,10 @@ ii. production enviroment docker build . ``` -or if installed docker-compose +or if installed docker compose ```zsh -docker-compose build +docker compose build ``` 2. Run containers @@ -115,7 +113,7 @@ docker-compose build docker start -d -p 80:80 container_id ``` -or if installed docker-compose +or if installed docker compose ```zsh docker-compose up -d @@ -137,7 +135,9 @@ Open in favorite browser [https://localhost](http://localhost) 6. `show_reading_time`- allowing you to show reading time 7. `children`- for header nesting to work 8. `[[extra.menu]]` - the main navigation on the site -9. `[[extra.header]]` - the header navigantion for the site +9. `[[extra.header_right]]`,`[[extra.header_left]]` - the header navigantion for the site +10. `theme_color` which allow tab coloring in safari +11. `relative_path` which prints in full url on the page ### Templates diff --git a/changelog.md b/content/changelog.md similarity index 92% rename from changelog.md rename to content/changelog.md index 5c1544e61825f52944a2c297a3e2ca6bc7fed746..d1a11249c1b0c18edfebb66d767b60b44afd2c18 100644 --- a/changelog.md +++ b/content/changelog.md @@ -1,4 +1,9 @@ -# [unreleased] ++++ +title = "Changelog" +weight = 4 ++++ + +# [0.2.0] ## New features @@ -6,8 +11,9 @@ - alpha search - new settings `relative_path` which prints in full page - new parameter `config.extra.theme_color` which allow tab coloring in safari -- experimental settings `header.container` +- experimental settings `header.container` activate by `devmode` - new Dockerfile +- setup postcss and swc to compiling ## Bug fixing diff --git a/content/configure.md b/content/configure.md index f9043aa5f67cfc8ad5759837bd47d29c4ac0a72a..6ef3624e8595e31c5fc796fe9b5df944ebdca649 100644 --- a/content/configure.md +++ b/content/configure.md @@ -14,7 +14,10 @@ weight = 2 6. `show_reading_time`- allowing you to show reading time 7. `children`- for header nesting to work 8. `[[extra.menu]]` - the main navigation on the site -9. `[[extra.header]]` - the header navigantion for the site +9. `[[extra.header_right]]`,`[[extra.header_left]]` - the header navigantion for the site +10. `theme_color` which allow tab coloring in safari +11. `relative_path` which prints in full url on the page +12. `devmode` activate experimental features ## Templates diff --git a/content/install.md b/content/install.md index 465323940966b1ada6035089bd003e3607a13afc..b82904e45875ce04cb1ffbfe7ed04fcd58776ccc 100644 --- a/content/install.md +++ b/content/install.md @@ -7,16 +7,14 @@ weight = 1 1. [Zola](https://www.getzola.org/documentation/getting-started/installation/) 2. [Node.js](https://nodejs.org/) +3. [rsync](https://rsync.samba.org/) install for your platform. ## Optional -1. [yj](https://github.com/sclevine/yj) - > for transfer toml file in yaml -2. [docker](https://docs.docker.com/engine/install/) +- [docker](https://docs.docker.com/engine/install/) > for packaging container -3. [rsync](https://rsync.samba.org/) > A better copy and move # Get Started @@ -62,20 +60,13 @@ how you can give freedom to your creativity ## 5. Run the project -### With [docker-compose](https://docs.docker.com/compose) and [cargo make](https://sagiegurari.github.io/cargo-make/) - -```zsh -cargo make --makefile make.toml dockerup -``` - -### Without - i. development enviroment 1. Install node dependencies needed to work ```zsh -npm run gen # don't use npm install before that +npm ci +npm run gen ``` 2. Just run `zola serve` in the root path of the project @@ -100,7 +91,7 @@ docker build . or if installed docker-compose ```zsh -docker-compose build +docker compose build ``` 2. Run containers @@ -109,10 +100,10 @@ docker-compose build docker start -d -p 80:80 container_id ``` -or if installed docker-compose +or if installed docker compose ```zsh -docker-compose up -d +docker compose up -d ``` Open in favorite browser [https://localhost](http://localhost) diff --git a/package.json b/package.json index 9ced8af823c64c3b36d0cf2cd13a03b7df337a76..8c96ac674d8adcd56c3b09e6a88b158cdee09bff 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "link": "rsync -va node_modules/@fontsource node_modules/katex node_modules/modern-normalize/modern-normalize.css static && npm run link:assets :", "link:assets": "mkdir -p static && cp -r assets static || :", "clean": "rm -rf static node_modules", - "gen": "npm run link && zola build && npm run postcss", + "gen": "npm run link && npm run compile:js && zola build && npm run postcss", "watch": "swc helpers --only -d static --watch & zola serve -O -f" }, "dependencies": {