create-harold-app - npm Package Compare versions

Comparing version 0.2.1 to 0.3.0

CHANGELOG.md

@@ -1,11 +0,15 @@
-## [0.2.1](https://github.com/juliancwirko/create-harold-app/releases/tag/v0.2.1) (2021-05-02)
+### [0.3.0](https://github.com/juliancwirko/create-harold-app/releases/tag/v0.3.0) (2021-05-02)
 
+configuration possibility
+
+### [0.2.1](https://github.com/juliancwirko/create-harold-app/releases/tag/v0.2.1) (2021-05-02)
+
 fix for search engine in the 'default' template
 
-## [0.2.0](https://github.com/juliancwirko/create-harold-app/releases/tag/v0.2.0) (2021-04-28)
+### [0.2.0](https://github.com/juliancwirko/create-harold-app/releases/tag/v0.2.0) (2021-04-28)
 
 update harold-scripts (switch from node-sass to sass)
 
-## [0.1.0](https://github.com/juliancwirko/create-harold-app/releases/tag/v0.1.0) (2021-04-25)
+### [0.1.0](https://github.com/juliancwirko/create-harold-app/releases/tag/v0.1.0) (2021-04-25)
 
 Initial release

package.json

 {
   "name": "create-harold-app",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Static blog/site generator",
@@ -5,0 +5,0 @@ "author": "Julian Ćwirko (julian.io)",

README.md

@@ -65,2 +65,30 @@ ## create-harold-app
 
+### Configuration
+
+Harold will search up the directory tree for configuration in the following places:
+
+- a `harold` property in package.json
+- a `.haroldrc` file in JSON or YAML format
+- a `.haroldrc.json`, `.haroldrc.yaml`, `.haroldrc.yml`, `.haroldrc.js`, or `.haroldrc.cjs` file
+- a `harold.config.js` or `harold.config.cjs` CommonJS module exporting an object
+
+For now, there isn't much to configure, but you can configure the directory for md files (by default `posts`) and the directory for md files layouts (by default `blog-layouts`). Quite helpful because these names are also used in urls. For example, by default, `/posts/name-of-the-post` (name of the .md file), but you might want to build the docs website and have `/docs/name-of-the-doc` (name of the .md file).
+
+Example of `.haroldrc` (placed in the root of your harold app):
+
+```
+{
+  mdFilesDirName: 'docs',
+  mdFilesLayoutsDirName: 'docs-layouts'
+}
+```
+
+Remember to change these directories' names after you init your app.
+If you are using the search system, change `postsPath` in `harold-search.js`.
+
+### Updating harold-scripts
+
+1. Check if there are any breaking changes in the `CHANGELOG.md`
+2. In your project, update the version of `harold-scripts` package
+
 ### Documentation
@@ -67,0 +95,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

159964

increased by0.86%

Number of lines in readme file

104

increased by36.84%

Number of medium supply chain risk alerts

1

decreased by-50%

No dependency changes