You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,13 @@ Contributions are **welcome** and will be fully **credited**.
4
4
5
5
Please read and understand the contribution guide before creating an issue or pull request. This document is a living standard that may be updated when needed.
6
6
7
+
7
8
## Resources
8
9
9
10
If you're new to HydePHP and are looking to contribute, it may be helpful to learn how the ecosystem and core development works.
10
11
It's thus highly advised you visit our [Developer Resources](https://hydephp.com/community) to learn how HydePHP is structured.
11
12
13
+
12
14
## Etiquette
13
15
14
16
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
@@ -21,6 +23,7 @@ world that developers are civilized and selfless people.
21
23
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
22
24
quality to benefit the project. Many developers have different skill sets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
23
25
26
+
24
27
## Viability
25
28
26
29
When requesting or submitting new features, first consider whether they might be useful to others. Open
@@ -51,13 +54,15 @@ Before submitting a pull request:
51
54
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
52
55
- Check the feature is a viable for the project (see above)
53
56
57
+
54
58
## How-to
55
59
56
60
HydePHP development is made in the HydePHP monorepo found at https://github.com/hydephp/develop.
57
61
To get started, you will need to clone the repository, and run `composer install`. You will then be able to make changes to the packages found in the `packages/` sub-directories.
58
62
59
63
Once you've made and commited your changes, submit a pull request to the same repository, and explain your changes and how they improve the codebase.
60
64
65
+
61
66
## Requirements
62
67
63
68
If the project maintainer has any additional requirements, you will find them listed here.
Copy file name to clipboardExpand all lines: README.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,7 @@
26
26
27
27
> This repository holds the source code for the HydePHP core components. If you want to create a website with Hyde, check out the [HydePHP/Hyde repository](https://github.com/hydephp/hyde).
*The Hyde/Hyde project is stored in the monorepo root and works a bit differently from the others. Before pushing to the readonly repository, we apply persisted changes in the [`packages/hyde`](https://github.com/hydephp/develop/tree/master/packages/hyde) directory, then remove monorepo specific files.
60
60
61
-
62
61
### How the monorepo works
63
62
64
63
Changes to HydePHP including some first-party packages are made here. The changes are then pushed to the `develop` or `master` branches of the readonly repositories seen in the table above.
65
64
66
-
67
65
### Releases
68
66
69
67
The versioning between the Framework and Hyde packages are linked together Meaning that if Hyde get's a major release, so must Framework, and vice versa. To make this easier, we also publish major and minor releases in the monorepo. Patch releases are not published in the monorepo, and are instead handled by the individual packages.
HydePHP is a content-first Laravel-powered Static Site Builder that allows you to create static HTML pages, blog posts, and documentation sites using Markdown.
13
15
Hyde is all about letting you get started quickly by giving you a full-featured frontend starter kit, while also giving you the power and freedom of doing things the way you want to.
Copy file name to clipboardExpand all lines: packages/hyde/README.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
1
# HydePHP - Elegant and Powerful Static Site Generator
2
2
3
-
4
3
[](https://packagist.org/packages/hyde/framework)
5
4
[](https://packagist.org/packages/hyde/framework)
## Make static websites, blogs, and documentation pages with the tools you already know and love.
12
11
13
12
### About HydePHP
13
+
14
14
HydePHP is a content-first Laravel-powered console application that allows you to create static HTML pages, blog posts, and documentation sites,
15
15
using your choice of Markdown and/or Blade.
16
16
17
17
Build sites in record-time with a full batteries-included TailwindCSS frontend that just works without any fuzz.
18
18
19
19
### Speed & simplicity first, full control when you need it.
20
+
20
21
Hyde is all about letting you get started quickly by giving you a full-featured frontend starter kit, while also giving you the power and freedom of doing things the way you want to.
21
22
22
23
Markdown purist? That's all you need. Blade artisan? Go for it.
@@ -25,35 +26,42 @@ You don't _need_ to customize anything. But you _can_ customize everything.
25
26
26
27
See the documentation and learn more at https://hydephp.com/docs/
27
28
29
+
28
30
## Features
29
31
30
32
### Content Creation
33
+
31
34
- Create blog posts using Markdown and Front Matter.
32
35
- Create documentation pages from plain Markdown, no front matter needed!
33
36
- Create simple pages using Markdown, or create advanced ones using Laravel Blade.
34
37
- You can scaffold blog posts and Markdown pages to automatically fill in the front matter.
35
38
- You can also scaffold Blade pages to automatically use the default layout.
36
39
37
40
### Built-in Frontend
41
+
38
42
- Hyde comes with a TailwindCSS starter kit so you can start making content right away.
39
43
- The starter kit is fully responsive, has a dark mode theme, and is customizable.
40
44
- The frontend is accessible to screenreaders and rich with semantic HTML and microdata.
41
45
- Hyde automatically chooses the right layout to use depending on the content being rendered.
42
46
- Hyde also fills in and creates content like navigation menus and sidebars automatically.
43
47
44
48
### Easy Asset Managing
49
+
45
50
- The Hyde starter comes with [HydeFront](https://github.com/hydephp/hydefront/) to serve the base stylesheet and JavaScript through the jsDelivr CDN.
46
51
- Hyde ships with precompiled and minified TailwindCSS styles in the app.css file, you can also load them through the CDN.
47
52
- This means that all the styles you need are already installed. However, if you want to customize the Tailwind config, or if you add new Tailwind classes through Blade files, you can simply run the `npm run dev` command to recompile the styles using Laravel Mix.
48
53
49
54
### Customization
55
+
50
56
- You don't need to configure anything as Hyde is shipped with sensible defaults.
51
57
- You can, however, customize nearly everything. Here are some examples:
52
58
- All frontend components and page layouts are created with Blade so you
53
59
can publish the vendor views, just like in Laravel.
54
60
- Override many of the dynamic content features like the menus and footer.
55
61
62
+
56
63
## Getting Started - High-level overview
64
+
57
65
> See [Installation Guide](https://hydephp.com/docs/master/installation.html) and [Getting Started](https://hydephp.com/docs/master/getting-started.html) for the full details.
58
66
59
67
It's a breeze to get started with Hyde. Create a new Hyde project using Composer:
@@ -70,6 +78,7 @@ When you're ready, run the build command to compile your static site which will
70
78
php hyde build
71
79
```
72
80
81
+
73
82
## Resources
74
83
75
84
### Changelog
@@ -97,6 +106,7 @@ All vulnerabilities will be promptly addressed.
97
106
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
98
107
99
108
### Attributions
109
+
100
110
> Please see the respective authors' repositories for their license files
101
111
102
112
- The Hyde core is built with [Laravel Zero](https://laravel-zero.com/) which is based on [Laravel](https://laravel.com/)
@@ -18,14 +19,19 @@ Normally, this file is imported into the main.css file.
18
19
-**App.css**:
19
20
A compiled and minified file containing the TailwindCSS styles for a base Hyde installation. It includes the Hyde.css file. This file is identical to what one would get by running `npm run prod` in a new HydePHP project (which incidentally is exactly how this file is generated).
20
21
22
+
21
23
## Usage
22
24
23
25
HydeFront is included with [HydePHP](https://github.com/hydephp/hyde) by default.
HydeFront is not intended to be used for standalone projects and comes with no warranties. Changes in HydeFront are tied to those in the Hyde Framework and differing versions may be incompatible.
Copy file name to clipboardExpand all lines: packages/realtime-compiler/README.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ The source code for the HydePHP Realtime Compiler/Server. This package is includ
4
4
5
5
The package adds a `php hyde serve` command which exposes a web server on port `8080` which will compile the requested web page on the fly and serve it to the browser.
6
6
7
+
7
8
## Supported Versions
8
9
9
10
This package is not intended to be used outside the HydePHP framework.
0 commit comments