@simple-blog-builder/core

1.0.4 • Public • Published

@simple-blog-builder/core

License: MIT NPM Version GitHub issues npm CodeFactor TypeScript

WIP

A component library to build up fast blogs with markdown files

Installation

npm install @simple-blog-builder/core

Usage

import { SBBCore, SBBCoreConfig, SBBCoreBlogEntry } from '@simple-blog-builder/core';

const blog = SBBCore.createBlog({
  blogTitle: 'My Blog',
  blogDescription: 'This is a simple blog',
});

const files: File[] = [
  new File('01-01-2024-blog-example.md', '...'),
  new File('01-01-2024-blog-example-2.md', '...'),
  new File('01-01-2024-blog-example-3.md', '...'),
];

blog.loadEntries(files)

Blog entry example

$HEADER
TITLE: 01-01-2024 Blog Example
AUTHOR: John Doe
DATE: 01-01-2024
TAGS: blog, example
$HEADER END

# Content

This is an example of a blog post. It is a simple example of how to use the blog template.

## Subtitle

This is a subtitle. It is a simple example of how to use the blog template.

License

[MIT License](https://opensource.org/licenses/MIT)

Docs

To this point, the library is just documented by code comments. There will be a documentation page soon. Since the library is still in development, the documentation is not a priority.

Support

Soon™

Package Sidebar

Install

npm i @simple-blog-builder/core

Weekly Downloads

0

Version

1.0.4

License

MIT

Unpacked Size

43.2 kB

Total Files

28

Last publish

Collaborators

  • josunlp