Skip to content

Commit 1a11c1c

Browse files
committed
WIP
1 parent 8ae99a3 commit 1a11c1c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+626
-310
lines changed

.github/FUNDING.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
github: :vendor_name
1+
github: dontfreakout

.github/ISSUE_TEMPLATE/config.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Ask a question
4-
url: https://github.com/vendor_slug/package_slug/discussions/new?category=q-a
4+
url: https://github.com/dontfreakout/laravel-editorjs-to-html/discussions/new?category=q-a
55
about: Ask the community for help
66
- name: Request a feature
7-
url: https://github.com/vendor_slug/package_slug/discussions/new?category=ideas
7+
url: https://github.com/dontfreakout/laravel-editorjs-to-html/discussions/new?category=ideas
88
about: Share ideas for new features
99
- name: Report a bug
10-
url: https://github.com/vendor_slug/package_slug/issues/new
10+
url: https://github.com/dontfreakout/laravel-editorjs-to-html/issues/new
1111
about: Report a reproducable bug

.github/SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Security Policy
22

3-
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
3+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ testbench.yaml
1212
vendor
1313
node_modules
1414
.php-cs-fixer.cache
15+
.php-cs-fixer.php

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
All notable changes to `:package_name` will be documented in this file.
3+
All notable changes to `laravel-editorjs-to-html` will be documented in this file.
44

55
## 1.0.0 - 202X-XX-XX
66

LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) :vendor_name <[email protected]>
3+
Copyright (c) dontfreakout <[email protected]>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+20-35
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,47 @@
1-
# :package_description
1+
# Editor.js blocks themeable parser for Laravel
22

3-
[![Latest Version on Packagist](https://img.shields.io/packagist/v/vendor_slug/package_slug.svg?style=flat-square)](https://packagist.org/packages/vendor_slug/package_slug)
4-
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/vendor_slug/package_slug/run-tests?label=tests)](https://github.com/vendor_slug/package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
5-
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/vendor_slug/package_slug/Check%20&%20fix%20styling?label=code%20style)](https://github.com/vendor_slug/package_slug/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
6-
[![Total Downloads](https://img.shields.io/packagist/dt/vendor_slug/package_slug.svg?style=flat-square)](https://packagist.org/packages/vendor_slug/package_slug)
7-
8-
---
9-
This repo can be used to scaffold a Laravel package. Follow these steps to get started:
10-
11-
1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
12-
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files
13-
3. Remove this block of text.
14-
4. Have fun creating your package.
15-
5. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
16-
---
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/dontfreakout/laravel-editorjs-to-html.svg?style=flat-square)](https://packagist.org/packages/dontfreakout/laravel-editorjs-to-html)
4+
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/dontfreakout/laravel-editorjs-to-html/run-tests?label=tests)](https://github.com/dontfreakout/laravel-editorjs-to-html/actions?query=workflow%3Arun-tests+branch%3Amain)
5+
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/dontfreakout/laravel-editorjs-to-html/Check%20&%20fix%20styling?label=code%20style)](https://github.com/dontfreakout/laravel-editorjs-to-html/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
6+
[![Total Downloads](https://img.shields.io/packagist/dt/dontfreakout/laravel-editorjs-to-html.svg?style=flat-square)](https://packagist.org/packages/dontfreakout/laravel-editorjs-to-html)
177

188
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
199

20-
## Support us
21-
22-
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
23-
24-
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
25-
26-
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
27-
2810
## Installation
2911

3012
You can install the package via composer:
3113

3214
```bash
33-
composer require vendor_slug/package_slug
15+
composer require dontfreakout/laravel-editorjs-to-html
3416
```
3517

36-
You can publish and run the migrations with:
18+
[comment]: <> (You can publish and run the migrations with:)
3719

38-
```bash
39-
php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag="package_slug-migrations"
40-
php artisan migrate
41-
```
20+
[comment]: <> (```bash)
21+
22+
[comment]: <> (php artisan vendor:publish --provider="Dontfreakout\LaravelEditorjsToHtml\LaravelEditorjsToHtmlServiceProvider" --tag="laravel-editorjs-to-html-migrations")
23+
24+
[comment]: <> (php artisan migrate)
25+
26+
[comment]: <> (```)
4227

4328
You can publish the config file with:
4429
```bash
45-
php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag="package_slug-config"
30+
php artisan vendor:publish --provider="Dontfreakout\LaravelEditorjsToHtml\LaravelEditorjsToHtmlServiceProvider" --tag="laravel-editorjs-to-html-config"
4631
```
4732

4833
This is the contents of the published config file:
4934

5035
```php
5136
return [
37+
'default-template' => 'default'
5238
];
5339
```
5440

5541
## Usage
56-
57-
```php
58-
$skeleton = new VendorName\Skeleton();
59-
echo $skeleton->echoPhrase('Hello, Spatie!');
42+
Package provides custom blade component to render Editor.js block JSON
43+
```blade
44+
<x-dfk::editor-to-html :editor-data="$editorjsJson" template="tailwind" />
6045
```
6146

6247
## Testing
@@ -79,7 +64,7 @@ Please review [our security policy](../../security/policy) on how to report secu
7964

8065
## Credits
8166

82-
- [:author_name](https://github.com/:author_username)
67+
- [Dontfreakout (Martin Vlček)](https://github.com/dontfreakout)
8368
- [All Contributors](../../contributors)
8469

8570
## License

composer.json

+15-14
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
{
2-
"name": "vendor_slug/package_slug",
3-
"description": ":package_description",
2+
"name": "dontfreakout/laravel-editorjs-to-html",
3+
"description": "Editor.js blocks themeable parser for Laravel",
44
"keywords": [
5-
":vendor_name",
5+
"dontfreakout",
66
"laravel",
7-
"package_slug"
7+
"laravel-editorjs-to-html"
88
],
9-
"homepage": "https://github.com/vendor_slug/package_slug",
9+
"homepage": "https://github.com/dontfreakout/laravel-editorjs-to-html",
1010
"license": "MIT",
1111
"authors": [
1212
{
13-
"name": ":author_name",
14-
"email": "[email protected]",
13+
"name": "Dontfreakout (Martin Vlček)",
14+
"email": "[email protected]",
1515
"role": "Developer"
1616
}
1717
],
1818
"require": {
19-
"php": "^8.0",
19+
"php": "^7.4",
2020
"spatie/laravel-package-tools": "^1.4.3",
21-
"illuminate/contracts": "^8.37"
21+
"illuminate/contracts": "^8.37",
22+
"ext-json": "*"
2223
},
2324
"require-dev": {
2425
"brianium/paratest": "^6.2",
@@ -30,13 +31,13 @@
3031
},
3132
"autoload": {
3233
"psr-4": {
33-
"VendorName\\Skeleton\\": "src",
34-
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories"
34+
"Dontfreakout\\LaravelEditorjsToHtml\\": "src",
35+
"Dontfreakout\\LaravelEditorjsToHtml\\Database\\Factories\\": "database/factories"
3536
}
3637
},
3738
"autoload-dev": {
3839
"psr-4": {
39-
"VendorName\\Skeleton\\Tests\\": "tests"
40+
"Dontfreakout\\LaravelEditorjsToHtml\\Tests\\": "tests"
4041
}
4142
},
4243
"scripts": {
@@ -50,10 +51,10 @@
5051
"extra": {
5152
"laravel": {
5253
"providers": [
53-
"VendorName\\Skeleton\\SkeletonServiceProvider"
54+
"Dontfreakout\\LaravelEditorjsToHtml\\LaravelEditorjsToHtmlServiceProvider"
5455
],
5556
"aliases": {
56-
"Skeleton": "VendorName\\Skeleton\\SkeletonFacade"
57+
"LaravelEditorjsToHtml": "Dontfreakout\\LaravelEditorjsToHtml\\LaravelEditorjsToHtmlFacade"
5758
}
5859
}
5960
},

config/editorjs-to-html.php

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?php
2+
// config for Dontfreakout/LaravelEditorjsToHtml
3+
return [
4+
'default-template' => 'default'
5+
];

config/skeleton.php

-5
This file was deleted.

configure.php

-130
This file was deleted.

database/factories/ModelFactory.php

-19
This file was deleted.

database/migrations/create_skeleton_table.php.stub

-19
This file was deleted.

phpunit.xml.dist

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
verbose="true"
2020
>
2121
<testsuites>
22-
<testsuite name="VendorName Test Suite">
22+
<testsuite name="Dontfreakout Test Suite">
2323
<directory>tests</directory>
2424
</testsuite>
2525
</testsuites>

0 commit comments

Comments
 (0)