generated from hydephp/hyde
-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #99 from hydephp/community-posts
Community guest posts
- Loading branch information
Showing
5 changed files
with
270 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -64,6 +64,57 @@ SOFTWARE. | |
|
||
</details> | ||
|
||
## HydePHP.com Content | ||
|
||
Please note that all content on HydePHP.com is the protected under copyright unless otherwise stated. | ||
|
||
### Guest Posts | ||
|
||
The HydePHP website accepts guest posts from the community. Open the dropdown to learn more about the legal aspects of these: | ||
|
||
<details> | ||
|
||
<summary>Legal Considerations</summary> | ||
|
||
**Copyright and Ownership** | ||
- Contributors retain full copyright and ownership of their submitted content | ||
- By submitting a guest post, you grant HydePHP.com a non-exclusive, worldwide, royalty-free license to publish and maintain the content | ||
- You confirm that the content is your original work or that you have the necessary rights to publish it | ||
- The guest post author is responsible for all aspects of the content they submit | ||
|
||
**Editorial Rights** | ||
We reserve the right to: | ||
- Accept or decline any submission without providing a reason | ||
- Schedule posts for publication at our discretion | ||
- Make minor edits for formatting, clarity, and consistency | ||
- Remove any content that violates our guidelines or terms | ||
- Update or modify these terms at any time | ||
|
||
**Attribution and Links** | ||
- We provide attribution to authors with their name and optional website link | ||
- For republished content, we may include canonical links to the original post | ||
- We do not compensate authors for guest posts | ||
- Authors may request removal of their content, though we retain the right to preserve archive copies | ||
|
||
**Content Guidelines** | ||
- All guest posts must comply with our Code of Conduct ([hydephp.com/code-of-conduct](code-of-conduct)) | ||
- Content must be suitable for our technical audience | ||
- Posts should not contain: | ||
- Malicious code or harmful instructions | ||
- Plagiarized content | ||
- Excessive self-promotion or advertising | ||
- Content that violates others' intellectual property rights | ||
|
||
**AI Usage and Disclosure** | ||
- We allow the use of AI tools to assist in the writing process (e.g., proofreading, editing, feedback) | ||
- Purely AI-generated content is not accepted | ||
- Authors must disclose any significant AI assistance used in creating their content | ||
- We reserve the right to reject submissions that don't meet our AI usage guidelines | ||
|
||
For questions about guest posts, please contact [email protected] or visit [hydephp.com/contact](contact). | ||
</details> | ||
|
||
|
||
## Attributions, Acknowledgements, and Credits | ||
|
||
Hyde would not be possible without the open-source community. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
--- | ||
title: 'Introducing Guest Posts on HydePHP.com' | ||
description: "We're excited to announce that HydePHP.com is now accepting guest posts from the community. Learn how you can contribute and share your knowledge with fellow developers." | ||
category: 'Guest Posts' | ||
author: | ||
name: HydePHP Team | ||
website: "https://hydephp.com" | ||
date: '2024-12-27 19:52' | ||
guest_post: false | ||
--- | ||
|
||
We're thrilled to announce that [HydePHP.com](https://hydephp.com/) is now accepting guest posts from our amazing community! Whether you're a Laravel enthusiast, a static site generation expert, or someone who has built something cool with HydePHP, we want to hear your story. | ||
|
||
## Why Write for HydePHP? | ||
|
||
- Share your knowledge and experiences with the wider PHP community | ||
- Get recognition with full attribution and links to your profile | ||
- Help others learn and grow while building your personal brand | ||
- Contribute to the open-source community in a meaningful way | ||
|
||
## What We're Looking For | ||
|
||
We welcome a variety of content that adds value to our community, including: | ||
|
||
- Tutorials and how-to guides for HydePHP features | ||
- Case studies of projects built with HydePHP | ||
- Best practices and tips for static site generation | ||
- Integration guides with other Laravel tools and services | ||
- Your unique experiences and insights using HydePHP | ||
- Talk about a package/extension you've built for HydePHP | ||
- Anything else you think is relevant to the HydePHP community | ||
|
||
## How to Submit Your Post | ||
|
||
1. Fork the [HydePHP.com repository](https://github.com/hydephp/hydephp.com) or use the [GitHub.com website](https://github.com/hydephp/hydephp.com/blob/master/_posts/guest-posts) | ||
2. Create your post file in the `_posts/guest-posts/` directory | ||
3. The filename should be the post title in kebab case | ||
4. Include the required front matter (example below) | ||
5. Submit one post per pull request | ||
|
||
Make sure to proofread your post to ensure proper spelling, grammar, and formatting. | ||
|
||
**Here's the required front matter template:** | ||
|
||
```yaml | ||
title: "Your Engaging Post Title" | ||
description: "A brief 1-2 sentence description of your post" | ||
category: "Guest Posts" | ||
author: | ||
name: "Your Name" | ||
website: "https://yourwebsite.com" # Optional | ||
date: "YYYY-MM-DD HH:MM" | ||
guest_post: true | ||
canonical_guest_post_url: "https://example.com/original-post" # Optional, for republished content | ||
``` | ||
### Style Guide | ||
Please use Markdown formatting for your post, and use a clear heading structure. You don't need to add a level one heading, as HydePHP adds that based on the front matter title. Start with level two headings, and try to only use level two and three headings. | ||
When using links, make sure these are not overly promotional, and that they only lead to relevant and useful resources. Paid/sponsored affiliate links are not allowed. | ||
## Guidelines and Terms | ||
To ensure a positive experience for everyone, please note: | ||
- All posts must follow our [Code of Conduct](https://hydephp.com/code-of-conduct) | ||
- Contributors retain copyright of their content while granting us publication rights | ||
- We reserve the right to: | ||
- Accept or decline submissions | ||
- Schedule posts for optimal publishing dates | ||
- Remove content that violates our guidelines | ||
- Make minor edits for formatting and clarity | ||
For republished content, we're happy to include canonical links to the original post, provided it aligns with our community guidelines. | ||
### Legal Considerations | ||
By submitting a guest post, you: | ||
- Retain full copyright ownership of your content | ||
- Grant HydePHP.com non-exclusive rights to publish and maintain your content | ||
- Confirm that the content is your original work or you have necessary rights to publish it | ||
- Agree to our [legal terms](https://hydephp.com/legal) | ||
### AI Usage Guidelines | ||
We welcome the use of AI as a supportive writing tool, as long as human creativity remains at the forefront. Here’s our stance: | ||
**Acceptable AI usage:** | ||
- Using AI tools for proofreading and editing | ||
- Getting feedback on structure and clarity | ||
- Brainstorming ideas and topics | ||
- Suggesting improvements to your writing | ||
However, we do not accept purely AI-generated content. All posts must be primarily written by humans, with AI serving as a supplementary tool rather than the primary author. | ||
If you use AI tools in your writing process, please disclose this in your pull request, briefly describing how AI assisted your work. This transparency helps us maintain the quality, authenticity, and accuracy of our community content. | ||
## Questions? | ||
We're here to help! Reach out to: | ||
- HydePHP creator [@CodeWithCaen on X/Twitter](https://x.com/CodeWithCaen) | ||
- Create an issue in the [GitHub repository](https://github.com/hydephp/hydephp.com/issues) | ||
We can't wait to see your contributions and share your knowledge with the HydePHP community! | ||
--- | ||
Ready to submit your first guest post? Head over to our [GitHub repository](https://github.com/hydephp/hydephp.com/blob/master/_posts/guest-posts) and start writing! |
59 changes: 59 additions & 0 deletions
59
resources/views/vendor/hyde/components/article-excerpt.blade.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
@php /** @var \Hyde\Pages\MarkdownPost $post */ @endphp | ||
<article class="mt-4 mb-8" itemscope itemtype="https://schema.org/Article"> | ||
<meta itemprop="identifier" content="{{ $post->identifier }}"> | ||
@if(Hyde::hasSiteUrl()) | ||
<meta itemprop="url" content="{{ Hyde::url('posts/' . $post->identifier) }}"> | ||
@endif | ||
|
||
<header class="flex items-center justify-between"> | ||
<a href="{{ $post->getRoute() }}" class="block w-fit"> | ||
<h2 class="text-2xl font-bold text-gray-700 hover:text-gray-900 dark:text-gray-200 dark:hover:text-white transition-colors duration-75"> | ||
{{ $post->data('title') ?? $post->title }} | ||
</h2> | ||
</a> | ||
@if($post->data('guest_post')) | ||
<span class="inline-block px-2 py-1 text-sm bg-indigo-100 text-indigo-800 dark:bg-indigo-900 dark:text-indigo-200 rounded-md mt-2"> | ||
Guest Post | ||
</span> | ||
@endif | ||
</header> | ||
|
||
<footer> | ||
@isset($post->date) | ||
<span class="opacity-75"> | ||
<span itemprop="dateCreated datePublished">{{ $post->date->short }}</span>{{ isset($post->author) ? ',' : '' }} | ||
</span> | ||
@endisset | ||
@isset($post->author) | ||
<span itemprop="author" itemscope itemtype="https://schema.org/Person"> | ||
<span class="opacity-75">by</span> | ||
@if($post->data('guest_post')) | ||
<span>guest author</span> | ||
@endif | ||
<span itemprop="name"> | ||
@if($post->author->website) | ||
<a href="{{ $post->author->website }}" class="hover:underline" rel="{{ $post->data('guest_post') ? 'author nofollow external' : 'author' }}" target="{{ $post->data('guest_post') ? '_blank' : '_self' }}"> | ||
@endif | ||
{{ $post->author->name ?? $post->author->username }} | ||
@if($post->author->website) | ||
</a> | ||
@endif | ||
</span> | ||
</span> | ||
@endisset | ||
</footer> | ||
|
||
@if($post->data('description') !== null) | ||
<section role="doc-abstract" aria-label="Excerpt"> | ||
<p class="leading-relaxed my-1"> | ||
{{ $post->data('description') }} | ||
</p> | ||
</section> | ||
@endisset | ||
|
||
<footer> | ||
<a href="{{ $post->getRoute() }}" class="text-indigo-500 hover:underline font-medium"> | ||
Read post | ||
</a> | ||
</footer> | ||
</article> |
28 changes: 28 additions & 0 deletions
28
resources/views/vendor/hyde/components/post/article.blade.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
<article aria-label="Article" id="{{ $page->identifier }}" itemscope itemtype="https://schema.org/Article" | ||
@class(['post-article mx-auto', config('markdown.prose_classes', 'prose dark:prose-invert'), 'torchlight-enabled' => Features::hasTorchlight()])> | ||
<meta itemprop="identifier" content="{{ $page->identifier }}"> | ||
@if($page->getCanonicalUrl() !== null) | ||
<meta itemprop="url" content="{{ $page->getCanonicalUrl() }}"> | ||
@endif | ||
|
||
<header aria-label="Header section" role="doc-pageheader"> | ||
<h1 itemprop="headline" class="mb-4">{{ $page->title }}</h1> | ||
<div id="byline" aria-label="About the post" role="doc-introduction"> | ||
@includeWhen(isset($page->date), 'hyde::components.post.date') | ||
@includeWhen(isset($page->author), 'hyde::components.post.author') | ||
@includeWhen(isset($page->category), 'hyde::components.post.category') | ||
</div> | ||
@if($page->matter('guest_post') && $page->matter('canonical_guest_post_url')) | ||
<p class="text-sm text-gray-600 dark:text-gray-400 italic mb-0 mt-2"> | ||
Originally posted at <a href="{{ $page->matter('canonical_guest_post_url') }}?ref=hydephp.com" class="text-indigo-600 dark:text-indigo-400 hover:underline" rel="canonical nofollow external" target="_blank"> | ||
{{ parse_url($page->matter('canonical_guest_post_url'), PHP_URL_HOST) }} | ||
</a> | ||
</p> | ||
@endif | ||
</header> | ||
@includeWhen(isset($page->image), 'hyde::components.post.image') | ||
<div aria-label="Article body" itemprop="articleBody"> | ||
{{ $content }} | ||
</div> | ||
<span class="sr-only">End of article</span> | ||
</article> |
23 changes: 23 additions & 0 deletions
23
resources/views/vendor/hyde/components/post/author.blade.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
@if($page->matter('guest_post')) | ||
by guest author | ||
<address itemprop="author" itemscope itemtype="https://schema.org/Person" aria-label="The post author" style="display: inline;"> | ||
@if($page->author->website) | ||
<a href="{{ $page->author->website }}" rel="author nofollow external" target="_blank" itemprop="url" aria-label="The author's website"> | ||
@endif | ||
<span itemprop="name" aria-label="The author's name">{{ $page->author->name ?? $page->author->username }}</span> | ||
@if($page->author->website) | ||
</a> | ||
@endif | ||
</address> | ||
@else | ||
by author | ||
<address itemprop="author" itemscope itemtype="https://schema.org/Person" aria-label="The post author" style="display: inline;"> | ||
@if($page->author->website) | ||
<a href="{{ $page->author->website }}" rel="author" itemprop="url" aria-label="The author's website"> | ||
@endif | ||
<span itemprop="name" aria-label="The author's name" {{ ($page->author->username && ($page->author->username !== $page->author->name)) ? 'title=@'. urlencode($page->author->username) : '' }}>{{ $page->author->name ?? $page->author->username }}</span> | ||
@if($page->author->website) | ||
</a> | ||
@endif | ||
</address> | ||
@endif |