tighten/jigsaw-site

Jigsaw Documentation Site

jigsaw-site's Issues

Blog posts

I was hoping to utilise Jigsaw for Blog posts. I wanted to write posts in markdown and then display a snippet of each post on the post index page with the ability to click through to each post.

Could you shed any light on how this can be achieved with Jigsaw/Blade?

Many thanks

Current Netlify config example wont build

Netlify's default build image is now PHP 7.4. There is an option (see image below) to set to PHP 7.2 image, but that won't satisfy current JigSaw dependencies.

Solution will require changing example config to use PHP 7.4 (7.3 won't work as not included in build image).

discussion re build image: netlify/build-image#366

Contribution guide/describe how to run tests

It would be nice if there was a contribution guide in the documentation. It should explain the general process (creating issues and PRs) and how to test.

From messing I found out I need to execute these 2 commandsthis command:

• php .\jigsaw build testing
• ./vendor/bin/phpunit

On a side note the build command is interactive, is there a flag to disable this behaviour? If this is possible the following script could be added to composer.json:

{
  "scripts" : {
    "test": [
      "php .\\jigsaw build testing",
      ".\\vendor\\bin\\phpunit"
    ]
  }
}

Tailwind 3 compatibility

With Tailwind 3 officially released, it would be great to have Jigsaw support it!

Torchlight api

Torchlight api is broken on a production site: https://jigsaw.tighten.com/docs/starter-templates/

Add instruction to run `npm install` before `npm run watch`

In the Building & Previewing section, the docs say:

If you are using Laravel Mix to compile your assets (which is included in the default Jigsaw setup), you can preview your site with Browsersync by simply running:

$ npm run watch

Browsersync will automatically open a new browser tab and reload the page every time you make a change. Very helpful for previewing your changes quickly!

However, when I first ran npm run watch, I saw errors. The full error output is here; the key part seemed to be this:

> @ local /Users/travis/Sites/jigsaw
> cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --progress --hide-modules --env=local --config=node_modules/laravel-mix/setup/webpack.config.js "--watch"

sh: cross-env: command not found

I then ran npm install, which was successful.

I then ran npm run watch again, which produced the expected results.

I suggest adding an instruction to run npm install before first running npm run watch to the docs. I'd be happy to create PR with this. I didn't do that preemptively because I'm new to using Jigsaw and I'm not 100% sure of the correct process for doing that in this repo, but given a tiny nudge in the right direction I'll make it happen 👌

License? Derived from Jigsaw-docs-template? Sidebar?

Hey guys,
I hope you are doing well.

There is no open source license oh this, any chance you would put this under an open-source license?

Some things are neat and a bit different than the default jigsaw-docs-template,
like the neat in-page right sidebar, and the colors are very nice too.
I could understand you might not want to open-source this, either.

Out of curiosity, was this project built upon the jigsaw-docs-template?
Just a matter of curiosity as I learn more about Laravel/Jigsaw.

Anyway, I hope you guys are all doing well, and staying safe, I'm in Seattle, and the
mood here is a bit tense with everything going on!

Of course, I have to thank you guys again for your awesome contributions to Laravel and open source. 💯

Suggestion: Add 'Using Netlify' section to Deploying Your Site page

netlify.toml

[build]

command = "npm run production"
publish = "build_production"

[build.environment]

PHP_VERSION = "7.2"

If possible add it above the GitHub Pages section because it skips the local build step and therefore has the simplest deployment process.

Tailwind version in jigsaw-site, and blog and docs templates

I am sure all the authors and maintainers are well aware of this, but I wanted to get opinions about whether this is worth fixing, or if someone with more experience than I is planning it.

While I am not a web-dev, I took a stab at using these Tailwind templates: Templates by Colm Tuite

They didn't really work so well at first, as they were written for TW 0.74 (I think), and they just loaded the current-up to date Tailwind CSS, where colors had changed from *-lighter to *-nnn (100-900),
and things like max-w-3xl had changed from 75rem to 48rem. (among other things)

I did manage to do my own upgrade of those templates using a tool to show missing css tags, and fixing max-* and other things that seemed wrong, but I am not a professional web-dev by any stretch.

The Jigsaw blog and doc templates also seem to be based on pre 1.x Tailwind also.

Anyway, curious if anyone is planning to upgrade this site, and the doc and blog templates?
Does anyone see it as valuable?
If it is seen as valuable I could take a stab at it, and submit a PR to see what others think.

My main concern is I am learning Tailwind, and I think it will be simpler for me to learn one version of Tailwind, and not to try to have to try to understand the two versions as I understand Tailwind better.

Thanks for any thoughts or suggestions!

Article on hosting a static site on S3

Hi Adam, here's my article on hosting a static site on S3: http://www.codehops.com/2016/02/08/host-a-static-site-on-aws-s3.html.

@include md files

Hello!
As Matt suggested, i will open this as an issue.

I know how to use md files, but i cannot @include them.
It would be great to have to possibility to @include Markup (md,...) files in an .blade.php file!

I, for example, have products (currently as blade.php) files, and i have some group-pages where i want to include those products by using an array.

I'd like to have those productsheets easily edited with markup by the customer:

{{--*/ $activeNav = ['products','NAME OF GROUP']; /*--}}
{{--*/ $allProductIncludes = [
   'productname1',
    'productname2',
    'productname3',
    'productname4',
    'productname5',
    'productname6',
    'productname7',
]; /*--}}
@section('conten')
    <h1>Special Products "NAME OF GROUP"</h1>
    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Servari enim iustitia nisi a forti viro, nisi a sapiente non potest. Semper enim</p>
    <div class="accordion" style="padding-top:0px; width:967px;">
        @foreach ($allProductIncludes as $productInclude)
            @include("_partials/products/$productInclude")
        @endforeach
    </div>
@endsection

This is currently working only with productname[1-7].blade.php, but not with productname[1-7].md files as the Markup is not been replaced through HTML.

btw:Thank you for that great piece of code!

Suggestion: Add page under Collections specifically about Adding Posts

When I was building my site, it took me longer than it should have to figure out how to add posts. You could take the content from this post from the Tighten blog which helped me figure it out.

Maybe add it as the first link under Collections in the sidebar to make it super obvious.

Starting a New Site

In the section Starting a New Site, the docs state (at the top) that you should run $ jigsaw init. This works only if you are in the project/vendor/bin folder, otherwise you get a 'command not found' error. My suggestion, the docs should really instruct to:

$ cd path/to/project
$ ./vendor/bin/jigsaw init

Add link to collections demo site

404 documentation could be improved

When setting up a custom 404 page, in addition to following the docs, I had to add to my location block as per this answer: https://serverfault.com/a/580038

My end result was:

location ~ \.php$ {
        try_files  $uri =404; // Added this line
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        fastcgi_pass unix:/var/run/php/php7.2-fpm.sock;
        fastcgi_index index.php;
        include fastcgi_params;
    }

Happy to PR an addition for this; to do so should I just edit this page and not worry about a build step, or something else?

source and build_production out of sync?

Just recently cloned the project to contribute but noticed the build_production and the source dir seem out of sync for example source/docs/deploying-your-site.md does not show the --env=production that the build_production files does. Am I missing something?