Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Import hydephp/docs #18

Merged
merged 224 commits into from
Jun 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
224 commits
Select commit Hold shift + click to select a range
efaf6b0
Initialize the repository
caendesilva Mar 19, 2022
3027021
Remove unneeded files
caendesilva Mar 19, 2022
604279a
Compile styles
caendesilva Mar 19, 2022
19da27e
Merge release from master
caendesilva Mar 19, 2022
c57c51a
Swap the index page from Blade to Markdown
caendesilva Mar 19, 2022
d08a22a
Merge command with master
caendesilva Mar 19, 2022
512b580
Disable blog posts
caendesilva Mar 19, 2022
1f13648
Merge with Master
caendesilva Mar 19, 2022
648c996
Begin adding the pages
caendesilva Mar 19, 2022
f7391e6
Initial commit
Mar 19, 2022
46df09a
Merge branch 'master' of github.com:hydephp/Docs
caendesilva Mar 19, 2022
8d07d02
Update Readme
caendesilva Mar 19, 2022
c2f435e
Create main.yml
Mar 19, 2022
364debc
Update README.md
caendesilva Mar 19, 2022
1268965
Update README.md
Mar 19, 2022
6d6a03a
Update README.md
Mar 19, 2022
f8a3561
Set redirect
caendesilva Mar 19, 2022
5876453
Update name to Build
caendesilva Mar 19, 2022
3bc34b5
Fix spelling and add link to next section
caendesilva Mar 19, 2022
5f6f05c
Move index page to blade redirect page
caendesilva Mar 19, 2022
3de33e9
Fix grammar
caendesilva Mar 19, 2022
f3a99c1
Add the directory structure page
caendesilva Mar 19, 2022
35c8cdb
Merge with master
caendesilva Mar 19, 2022
b48d9fc
Fix typo where camelcase was used instead of kebab
caendesilva Mar 19, 2022
5325eaa
Add blog post and getting started section
caendesilva Mar 19, 2022
d2900c5
Add a Header section to the index
caendesilva Mar 19, 2022
de18bfc
Add posts and footer
caendesilva Mar 19, 2022
7c1677b
Build the assets
caendesilva Mar 19, 2022
6ef88c5
Tweak the frontpage styles
caendesilva Mar 19, 2022
e2980f6
Add GitHub link
caendesilva Mar 19, 2022
e79d656
Add blog post about why to use static sites
caendesilva Mar 19, 2022
b907bbe
Merge package.json with master
caendesilva Mar 19, 2022
e0d94c0
Add Console Commands page
caendesilva Mar 19, 2022
d0d2fca
Build assets
caendesilva Mar 19, 2022
a91c6ac
Remove line numbers and fix GitHub link
caendesilva Mar 19, 2022
bbd0ed9
Fix broken link
caendesilva Mar 19, 2022
9863825
Add the tutorial link
caendesilva Mar 20, 2022
8c518ed
Add documentation for the validator command
caendesilva Mar 20, 2022
2b010f6
Add the Publish Command
caendesilva Mar 20, 2022
339dad9
Add documentation about images
caendesilva Mar 20, 2022
32d4a2f
Add "Customizing your Site"
caendesilva Mar 21, 2022
a42aac4
Merge branch 'master' of https://github.com/hydephp/hyde into hyde-up…
caendesilva Mar 21, 2022
5169efd
Update and build the frontend
caendesilva Mar 21, 2022
a32d6c8
Update the sidebar order
caendesilva Mar 21, 2022
6781703
Merge pull request #1 from hydephp/hyde-update
caendesilva Mar 21, 2022
90444ba
Merge tag 'v0.3.0-alpha' of https://github.com/hydephp/hyde into v0.3…
caendesilva Mar 22, 2022
48fe5f6
Update view to v0.3.0
caendesilva Mar 22, 2022
5c85eea
Build assets for new 404 page
caendesilva Mar 22, 2022
0a1bed6
Merge pull request #3 from hydephp/v0.3-update
caendesilva Mar 22, 2022
a3d9140
Merge branch 'master' of https://github.com/hydephp/hyde into v0.3-up…
caendesilva Mar 23, 2022
b42a3d4
Update framework to 0.4.3
caendesilva Mar 23, 2022
adec358
Update frontend to v0.3.3
caendesilva Mar 23, 2022
a36b013
Merge pull request #5 from hydephp/v0.3-update
caendesilva Mar 23, 2022
4400f7f
Merge branch 'master' of https://github.com/hydephp/hyde
caendesilva Mar 25, 2022
9027dc5
Update Hyde to v0.5
caendesilva Mar 25, 2022
0e67043
Rebuild pages
caendesilva Mar 25, 2022
993389b
Version the docs
caendesilva Mar 25, 2022
8b8ea02
Update the documentation to 0.5
caendesilva Mar 25, 2022
72a575a
Build the site
caendesilva Mar 25, 2022
35fbd5d
Update the docs to Master
caendesilva Mar 25, 2022
6ad25b1
Fix broken link
caendesilva Mar 25, 2022
c5c7585
Update the layout view path
caendesilva Mar 26, 2022
eb7f9c8
Add a tutorial blog post
caendesilva Mar 26, 2022
f980370
Re-run Torchlight
caendesilva Mar 26, 2022
7a32477
Merge branch 'master' of github.com:hydephp/Docs
caendesilva Mar 26, 2022
584356f
Update documentation for Markdown pages to v0.6
caendesilva Mar 26, 2022
24c8776
Create the page
caendesilva Mar 28, 2022
99df20d
Build the site
caendesilva Mar 28, 2022
aae5b6e
Update the intro heading section
caendesilva Mar 29, 2022
2191a7d
Rebuild assets
caendesilva Mar 29, 2022
6eb0c4e
Move brackets to same line
caendesilva Mar 29, 2022
63f88e8
Add a very WIP semantic HTML section
caendesilva Mar 29, 2022
d3659d9
Build the site
caendesilva Mar 29, 2022
dc2b8ef
Merge pull request #6 from hydephp/gallery
caendesilva Mar 29, 2022
07db507
Add an under construction banner
caendesilva Mar 29, 2022
f196717
Add the WIP banner and subtitle
caendesilva Mar 29, 2022
da3064a
Remove Hyde files
caendesilva Mar 30, 2022
a046d76
Remove Hyde files
caendesilva Mar 30, 2022
f22f267
Delete .gitignore
caendesilva Mar 30, 2022
cb01d67
Merge pull request #7 from hydephp/docs
Mar 30, 2022
7a88cfe
Create deploy.yml
Mar 30, 2022
86505f2
Update deploy.yml
Mar 30, 2022
1705944
Update deploy.yml
Mar 30, 2022
f040ff4
Update deploy.yml
Mar 30, 2022
9793c8e
Update deploy.yml
Mar 30, 2022
64db293
Update deploy.yml
Mar 30, 2022
8476eb5
Update deploy.yml
Mar 30, 2022
ee7d305
Update deploy.yml
Mar 30, 2022
97a7114
Update deploy.yml
Mar 30, 2022
7816d85
Update index.md
caendesilva Mar 30, 2022
5094592
Create the .nojekyll file
Mar 30, 2022
eede8ea
Revert #5094592
Mar 30, 2022
e8d017d
Create README.md
caendesilva Mar 31, 2022
aaa8d03
Remove duplicate name in title heading
caendesilva Mar 31, 2022
4d93ddb
Rename README.md to README.markdown
caendesilva Mar 31, 2022
e6c548e
Update links
caendesilva Mar 31, 2022
a96aaae
Add the CI action badge
caendesilva Mar 31, 2022
8d971ff
Update out of date information
caendesilva Apr 1, 2022
e012317
Add info about make:page command
caendesilva Apr 1, 2022
240673f
Fix broken links
caendesilva Apr 1, 2022
99aa263
Update docs
caendesilva Apr 3, 2022
b648c43
Update docs to v0.9.x
caendesilva Apr 7, 2022
f3dd347
Update documentation index page
caendesilva Apr 10, 2022
f1fe60a
Add update guide
caendesilva Apr 12, 2022
a640346
Add codeblock language for syntax highlighting
caendesilva Apr 12, 2022
137add0
Update headings
caendesilva Apr 12, 2022
e0225f5
Update docs to v.0.10.x
caendesilva Apr 14, 2022
5ba0132
Update installation.md
caendesilva Apr 16, 2022
e7ea09e
Update documentation to 0.14.x
caendesilva Apr 21, 2022
04f6b0a
Merge branch 'master' of github.com:hydephp/Docs
caendesilva Apr 21, 2022
3b5ecd3
Update test workflow name
caendesilva Apr 21, 2022
c9ba045
Create managing-assets.md
caendesilva May 1, 2022
f140028
Add link to the DocsCI repo
caendesilva May 1, 2022
dddda9f
Add webpack modification option information
caendesilva May 1, 2022
0583815
Add warning that _site directory is emptied
caendesilva May 3, 2022
14af6ea
Remove pull_request dispatch
caendesilva May 3, 2022
ccb6406
Merge pull request #15 from hydephp/add-warning-that-output-directory…
caendesilva May 3, 2022
92f81bf
Add a note on NPM/NodeJS
caendesilva May 4, 2022
566dda3
Merge pull request #16 from hydephp/caendesilva-patch-1
caendesilva May 4, 2022
a7d2d9a
Add draft
caendesilva May 4, 2022
95ef430
Move managing assets out from drafts
caendesilva May 4, 2022
edef007
Update badges
caendesilva May 4, 2022
c89ff67
Update readme contents
caendesilva May 4, 2022
ad63e4a
Update title to remove redundant app name
caendesilva May 4, 2022
874e6de
Change alpha warning to beta
caendesilva May 7, 2022
0f90b50
Update how-does-it-work.md
caendesilva May 7, 2022
bf88684
Create Quick Start Guide
caendesilva May 9, 2022
ee967d5
Add front matter block to make Symfony happy
caendesilva May 9, 2022
e0b948f
Change heading levels, fix grammar
caendesilva May 9, 2022
1d01c26
Begin rewriting documentation
caendesilva May 9, 2022
cf6483a
Remove Hyde/Hyde version shield
caendesilva May 9, 2022
a02b65a
Rename quick start to quickstart
caendesilva May 9, 2022
867585a
Override label
caendesilva May 9, 2022
58e436b
Slim down index page
caendesilva May 9, 2022
98a5868
Create console-commands.md
caendesilva May 9, 2022
b7e9382
Remove old files from dev branch
caendesilva May 9, 2022
353ffca
Create Readme
caendesilva May 9, 2022
e233548
Format markdown header
caendesilva May 9, 2022
e64c651
Remove "next steps" section
caendesilva May 9, 2022
4241915
Merge branch 'rewrite-docs' of github.com:hydephp/Docs into rewrite-docs
caendesilva May 9, 2022
169a9c6
Update CLI section with link to further docs
caendesilva May 9, 2022
8326c7a
Create creating-blog-posts.md
caendesilva May 9, 2022
cfa23df
Change heading Featured Post Image to Featured Image
caendesilva May 10, 2022
13c2bd3
Add Best Practices and Hyde Expectations
caendesilva May 10, 2022
f4368e2
Remove used in sections
caendesilva May 10, 2022
83a26d6
Rewrite schema section to be more readable and clear
caendesilva May 10, 2022
9b5eff1
Add output path to filenames section
caendesilva May 10, 2022
c64c599
Remove <br> tag
caendesilva May 10, 2022
5f741ac
Create creating-static-pages.md
caendesilva May 10, 2022
cbd1356
Add When to use which? section
caendesilva May 10, 2022
ae46f92
Update headings
caendesilva May 10, 2022
be91f23
Change HTML heading to blockquote tip
caendesilva May 10, 2022
cabe977
Add code block language types
caendesilva May 10, 2022
d7c8569
Reorder sections
caendesilva May 10, 2022
6bf130a
Fix spacing typo
caendesilva May 10, 2022
f2dea85
Create creating-documentation-pages.md
caendesilva May 10, 2022
bca68d8
Remove unintended backticks
caendesilva May 10, 2022
eb16c0d
Create markdown.md, fixes #17
caendesilva May 10, 2022
7943370
Add link to Markdown page
caendesilva May 10, 2022
dc41e5d
Fix links
caendesilva May 10, 2022
9984f18
Update labels
caendesilva May 10, 2022
0e72725
Add Documentation syntax section
caendesilva May 10, 2022
6739ebf
Create managing-assets.md
caendesilva May 10, 2022
4254487
Set sidepar priorities in front matter
caendesilva May 10, 2022
02e2a5e
Split Markdown.md into new files
caendesilva May 10, 2022
f5dfeec
Create customization.md
caendesilva May 10, 2022
13b8c5e
Create architecture-concepts.md
caendesilva May 10, 2022
0fcc376
Add categories (NYI)
caendesilva May 10, 2022
79ab910
Add the old documentation
caendesilva May 10, 2022
de545ef
Add some key concepts in Hyde
caendesilva May 10, 2022
7f93264
Add Further reading to quickstart
caendesilva May 10, 2022
4eef3fb
Add Using images in posts section
caendesilva May 10, 2022
139206b
Create updating-hyde.md
caendesilva May 10, 2022
9b749ca
Set and change page label
caendesilva May 10, 2022
fc2e924
Rename filenames
caendesilva May 10, 2022
c34151a
Update internal links
caendesilva May 10, 2022
6c97765
Create (admittedly terrible) troubleshooting page
caendesilva May 10, 2022
a1d0248
Set label
caendesilva May 10, 2022
54c1abe
Expand link text
caendesilva May 10, 2022
40059f1
Create extensions.md
caendesilva May 10, 2022
b1a9f51
Link directly to the Torchlight section
caendesilva May 10, 2022
0d19e04
Add config to directory structure
caendesilva May 10, 2022
15d1837
Specify and clarify vendor view directory
caendesilva May 10, 2022
c759e70
Add note about nested directories
caendesilva May 10, 2022
24cd9ef
Add directory structure
caendesilva May 10, 2022
c69947f
Link to directory structure section
caendesilva May 10, 2022
83cfad7
Add Requirements section
caendesilva May 10, 2022
b68110b
Fix broken links
caendesilva May 10, 2022
80e5210
Update frontend styles section
caendesilva May 10, 2022
f80ad5c
Remove extra closing tag
caendesilva May 10, 2022
2afa150
Fix grammar and formatting
caendesilva May 10, 2022
35f4a2e
Fix grammar
caendesilva May 10, 2022
2caf8fd
Fix typos
caendesilva May 10, 2022
60e70f6
Rename file as it had the case inverted
caendesilva May 10, 2022
ccb03ad
Merge Readme, readying for PR
caendesilva May 10, 2022
0a4b544
Merge .github with master
caendesilva May 10, 2022
14ccdc9
Add redirect files
caendesilva May 10, 2022
9ac747b
Merge pull request #18 from hydephp/rewrite-docs
caendesilva May 10, 2022
baea128
Document the sidebar grouping feature for https://github.com/hydephp/…
caendesilva May 11, 2022
e400c48
Merge pull request #20 from hydephp/sidebar-grouping
caendesilva May 11, 2022
a44d629
Update --run-prettier docs
caendesilva May 16, 2022
4eb3f1d
Update website links to hydephp.com
caendesilva May 16, 2022
6755c97
Add composer update command to update process
caendesilva May 17, 2022
1c43cc4
Add "upcoming Hyde documentation" readme
caendesilva May 19, 2022
58cb1e0
Update sidebar priorities
caendesilva May 20, 2022
e8fb0b5
Add Compile & Deploy page
caendesilva May 20, 2022
2b5cba1
Add Sitemaps and RSS feeds
caendesilva May 20, 2022
feaf0e1
Add Sitemaps and RSS feeds
caendesilva May 20, 2022
49ff460
Add Compile TailwindCSS directly
caendesilva May 20, 2022
812ad77
Merge pull request #22 from hydephp/upcoming
caendesilva May 20, 2022
18c4c30
Update Twitter handle
caendesilva May 24, 2022
958137a
Merge branch 'master' into upcoming
caendesilva May 30, 2022
8cd6f81
Update docs to v0.29.x
caendesilva May 30, 2022
58f36ab
Merge pull request #23 from hydephp/upcoming
caendesilva May 30, 2022
93fb1fd
Create advanced-markdown.md
caendesilva May 31, 2022
f1b97b2
Merge pull request #24 from hydephp/upcoming
caendesilva May 31, 2022
b3abf61
Add files via upload
caendesilva Jun 3, 2022
fa0e3a0
Merge pull request #25 from hydephp/update-to-v0.31.x
caendesilva Jun 3, 2022
6377f77
Revert "Add "upcoming Hyde documentation" readme"
caendesilva Jun 3, 2022
6f80a5c
Merge with Framework
caendesilva Jun 3, 2022
2319c96
Merge with upstream
caendesilva Jun 3, 2022
2472447
Move documentation files into docs/
caendesilva Jun 8, 2022
5efd146
Merge remote-tracking branch 'hydephp/docs'
caendesilva Jun 8, 2022
e4b0b0d
Restore merge conflics
caendesilva Jun 8, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# This is a basic workflow to help you get started with Actions
name: CI Deploy

# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ master ]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

permissions:
contents: read

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "deploy"
deploy:
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3

# Copy over the root Markdown files into a new directory
- name: Copy Markdown files
run: mkdir files && cp *.md files

- name: Push Markdown files
uses: cpina/github-action-push-to-another-repository@main
env:
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
with:
source-directory: 'files'
target-directory: '_docs'
destination-github-username: 'hydephp'
destination-repository-name: 'DocsCI'
target-branch: master
5 changes: 5 additions & 0 deletions docs/README.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Hyde Documentation
[![CI Deploy](https://github.com/hydephp/docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/hydephp/docs/actions/workflows/deploy.yml)

This is the source for the HydePHP Documentation. Updates to this repo are automatically propagated to the [DocsCI pipeline](https://github.com/hydephp/DocsCI) which uses Hyde to build the static site hosted at
https://hydephp.com/docs
53 changes: 53 additions & 0 deletions docs/advanced-markdown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
label: "Advanced Markdown"
priority: 26
category: "Digging Deeper"
---

# Advanced Markdown

## Introduction

Since HydePHP makes heavy use of Markdown there are some extra features and helpers
created just for Hyde to make using Markdown even easier!

## Blade Support

Since Hyde v0.30.x you can use Laravel Blade in Markdown files!

### Using Blade in Markdown

To use Blade in your Markdown files, simply use the Blade shortcode directive,
followed by your desired Blade string.

#### Standard syntax

```markdown
[Blade]: {{ "Hello World!" }} // Will render: 'Hello World!'
```

#### Blade includes

Only single-line shortcode directives are supported. If you need to use multi-line Blade code,
use an `@include` directive to render a more complex Blade template.
You can pass data to includes by specifying an array to the second argument.

```markdown
[Blade]: @include("hello-world")
[Blade]: @include("hello", ["name" => "World"])
```

### Enabling Blade-supported Markdown
It's disabled by default since it allows arbitrary PHP to run, which could be a security risk,
depending on your setup. However, if your Markdown is trusted, and you know it's safe,
you can enable it in the `config/markdown.php` file.

```php
// torchlight! {"lineNumbers": false}
'enable_blade' => true,
```

#### Limitations

All shortcodes must be the first word on a new line.
For example, using a space before the `[Blade]:` will intentionally cause it to not render.
94 changes: 94 additions & 0 deletions docs/architecture-concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
priority: 10
category: "Getting Started"
---

# Some key concepts in Hyde

## The HydeCLI

When you are not writing Markdown and Blade, most of your interactions with Hyde will be through the
Hyde Command Line Interface (CLI).
Since the CLI is based on the Laravel Artisan Console, so you may actually already be familiar with it.

You should take a look at [the Console Commands page](console-commands.html)
to learn more and see the available commands and their usage.

```bash
php hyde <command> [--help]
```

## Directory structure

To take full advantage of the framework, it may first be good to familiarize ourselves with the directory structure.

```
// torchlight! {"lineNumbers": false}
├── _docs // For documentation pages
├── _posts // For blog posts
├── _pages // For static Markdown and Blade pages
├── _media // Store static assets to be copied to the build directory
├── _site // The build directory where your compiled site will be stored
├── config // Configuration files for Hyde and integrations
├── resources/assets // Location for Laravel Mix source files (optional)
└── resources/views/components // Location for Blade components (optional)
```

> Note that the `_site` directory is emptied every time you run the `hyde build` command.
> It's intended that you keep the directory out of your VCS, for example by adding it to your .gitignore file.


## File Autodiscovery

Content files, meaning source Markdown and Blade files, are automatically
discovered by Hyde and compiled to HTML when building the site.
This means that you don't need to worry about routing and controllers!

The directory a source file is in will determine the Blade template that is used to render it.

Here is an overview of the content source directories, the output directory of the compiled files,
and the file extensions supported by each. Files starting with an `_underscore` are ignored.

| Page/File Type | Source Directory | Output Directory | File Extensions |
|----------------|------------------|------------------|---------------------|
| Static Pages | `_pages/` | `_site/` | `.md`, `.blade.php` |
| Blog Posts | `_posts/` | `_site/posts/` | `.md` |
| Documentation | `_docs/` | `_site/docs/` | `.md` |
| Media Assets | `_media/` | `_site/media/` | See full list below |

<small>
<blockquote>
Media file types supported: `.png`, `.svg`, `.jpg`, `.jpeg`, `.gif`, `.ico`, `.css`, `.js`
</blockquote>
</small>

## Convention over Configuration

Hyde favours the "Convention over Configuration" paradigm and thus comes preconfigured with sensible defaults.
However, Hyde also strives to be modular and endlessly customizable hackable if you need it.
Take a look at the [customization and configuration guide](customization.html) to see the endless options available!

## Front Matter

All Markdown content files support Front Matter. Blog posts for example make heavy use of it.

The specific usage and schemas used for pages are documented in their respective documentation,
however, here is a primer on the fundamentals.

- Front matter is stored in a block of YAML that starts and ends with a `---` line.
- The front matter should be the very first thing in the Markdown file.
- Each key-pair value should be on its own line.

**Example:**
```markdown
---
title: "My New Post"
author:
name: "John Doe"
website: https://mrhyde.example.com
---

## Markdown comes here

Lorem ipsum dolor sit amet, etc.
```
Loading