fix(documentation): Remove unnecessary markdown syntax from the README.

This commit is contained in:
Philipp Kunz 2025-01-24 02:04:54 +01:00
parent 9b31263a32
commit 4d0c97f948
3 changed files with 6 additions and 3 deletions

View File

@ -1,5 +1,10 @@
# Changelog
## 2025-01-24 - 2.2.1 - fix(documentation)
Remove unnecessary markdown syntax from the README.
- Fixed minor formatting issue in the README file by removing extraneous markdown syntax.
## 2025-01-24 - 2.2.0 - feat(core)
Initial release of smartfm module for handling frontmatter

View File

@ -1,4 +1,3 @@
```markdown
# @push.rocks/smartfm
The `@push.rocks/smartfm` module handles frontmatter data in markdown and other text files. The module allows easy parsing, stringification, and extraction of frontmatter data, using YAML or JSON format. It leverages the `gray-matter` library for advanced functionality with a simple API.
@ -188,7 +187,6 @@ By combining `@push.rocks/smartfm` with a markdown parsing library like `marked`
With these examples, you can see how `@push.rocks/smartfm` fits into various workflows involving frontmatter and text processing. The module's simplicity and effectiveness make it a suitable choice for projects that require clean handling of document metadata.
Feel free to explore and extend these examples based on your particular use case. Whether you are building a simple script, a web application, or an extensive content management system, `@push.rocks/smartfm` provides a robust foundation for frontmatter operations. Happy coding!
```
## License and Legal Information

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@push.rocks/smartfm',
version: '2.2.0',
version: '2.2.1',
description: 'A Node.js module for handling and processing frontmatter in markdown and text files, leveraging the gray-matter library for parsing and stringifying YAML or JSON formatted frontmatter.'
}