Skip to content

Commit f1aeeb8

Browse files
Set up repository & initial implementation
1 parent d936186 commit f1aeeb8

19 files changed

+141
-475
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
github: :vendor_name
1+
github: spatie

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 3 deletions
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_name/:package_name/discussions/new?category=q-a
4+
url: https://github.com/spatie/commonmark-wire-navigate/discussions/new?category=q-a
55
about: Ask the community for help
66
- name: Request a feature
7-
url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas
7+
url: https://github.com/spatie/commonmark-wire-navigate/discussions/new?category=ideas
88
about: Share ideas for new features
99
- name: Report a security issue
10-
url: https://github.com/:vendor_name/:package_name/security/policy
10+
url: https://github.com/spatie/commonmark-wire-navigate/security/policy
1111
about: Learn how to notify us for sensitive bugs

.github/workflows/fix-php-code-style-issues-cs-fixer.yml

Lines changed: 0 additions & 30 deletions
This file was deleted.

.github/workflows/run-tests-phpunit.yml

Lines changed: 0 additions & 48 deletions
This file was deleted.

.php-cs-fixer.dist.php

Lines changed: 0 additions & 39 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Changelog
22

3-
All notable changes to `:package_name` will be documented in this file.
3+
All notable changes to `commonmark-wire-navigate` will be documented in this file.
44

LICENSE.md

Lines changed: 1 addition & 1 deletion
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) spatie <[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

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,14 @@
1-
# :package_description
2-
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-
[![Tests](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions/workflows/run-tests.yml)
5-
[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
6-
<!--delete-->
7-
---
8-
This package can be used as to scaffold a framework agnostic package. Follow these steps to get started:
9-
10-
1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
11-
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files
12-
3. Have fun creating your package.
13-
4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
14-
---
15-
<!--/delete-->
1+
# Add a wire:navigate attribute to links rendered in Markdown
2+
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/commonmark-wire-navigate.svg?style=flat-square)](https://packagist.org/packages/spatie/commonmark-wire-navigate)
4+
[![Tests](https://img.shields.io/github/actions/workflow/status/spatie/commonmark-wire-navigate/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/spatie/commonmark-wire-navigate/actions/workflows/run-tests.yml)
5+
[![Total Downloads](https://img.shields.io/packagist/dt/spatie/commonmark-wire-navigate.svg?style=flat-square)](https://packagist.org/packages/spatie/commonmark-wire-navigate)
6+
167
This is where your description should go. Try and limit it to a paragraph or two. Consider adding a small example.
178

189
## Support us
1910

20-
[<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)
11+
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/commonmark-wire-navigate.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/commonmark-wire-navigate)
2112

2213
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).
2314

@@ -28,14 +19,14 @@ We highly appreciate you sending us a postcard from your hometown, mentioning wh
2819
You can install the package via composer:
2920

3021
```bash
31-
composer require :vendor_slug/:package_slug
22+
composer require spatie/commonmark-wire-navigate
3223
```
3324

3425
## Usage
3526

3627
```php
37-
$skeleton = new VendorName\Skeleton();
38-
echo $skeleton->echoPhrase('Hello, VendorName!');
28+
$skeleton = new Spatie\CommonMarkWireNavigate();
29+
echo $skeleton->echoPhrase('Hello, Spatie!');
3930
```
4031

4132
## Testing
@@ -58,7 +49,7 @@ Please review [our security policy](../../security/policy) on how to report secu
5849

5950
## Credits
6051

61-
- [:author_name](https://github.com/:author_username)
52+
- [sebastiandedeyne](https://github.com/sebastiandedeyne)
6253
- [All Contributors](../../contributors)
6354

6455
## License

composer.json

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,48 @@
11
{
2-
"name": ":vendor_slug/:package_slug",
3-
"description": ":package_description",
2+
"name": "spatie/commonmark-wire-navigate",
3+
"description": "Add a wire:navigate attribute to links rendered in Markdown",
44
"keywords": [
5-
":vendor_name",
6-
":package_slug"
5+
"spatie",
6+
"commonmark-wire-navigate"
77
],
8-
"homepage": "https://github.com/:vendor_slug/:package_slug",
8+
"homepage": "https://github.com/spatie/commonmark-wire-navigate",
99
"license": "MIT",
1010
"authors": [
1111
{
12-
"name": ":author_name",
13-
"email": "[email protected]",
12+
"name": "sebastiandedeyne",
13+
"email": "[email protected]",
1414
"role": "Developer"
1515
}
1616
],
1717
"require": {
18-
"php": "^8.1"
18+
"php": "^8.1",
19+
"league/commonmark": "^2.4",
20+
"spatie/url": "^2.4"
1921
},
2022
"require-dev": {
21-
:require_dev_testing,
22-
:require_dev_codestyle,
23+
"pestphp/pest": "^2.15",
24+
"laravel/pint": "^1.0",
2325
"spatie/ray": "^1.28"
2426
},
2527
"autoload": {
2628
"psr-4": {
27-
"VendorName\\Skeleton\\": "src"
29+
"Spatie\\CommonMarkWireNavigate\\": "src"
2830
}
2931
},
3032
"autoload-dev": {
3133
"psr-4": {
32-
"VendorName\\Skeleton\\Tests\\": "tests"
34+
"Spatie\\CommonMarkWireNavigate\\Tests\\": "tests"
3335
}
3436
},
3537
"scripts": {
36-
:scripts_testing,
37-
:scripts_codestyle
38+
"test": "vendor/bin/pest",
39+
"test-coverage": "vendor/bin/pest --coverage",
40+
"format": "vendor/bin/pint"
3841
},
3942
"config": {
4043
"sort-packages": true,
4144
"allow-plugins": {
42-
:plugins_testing,
45+
"pestphp/pest-plugin": true,
4346
"phpstan/extension-installer": true
4447
}
4548
},

0 commit comments

Comments
 (0)