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

Docs: updates #6407

Merged
merged 2 commits into from Oct 3, 2017

Conversation

Projects
None yet
4 participants
@DirtyF
Member

DirtyF commented Oct 2, 2017

A mass review of the documentation addressing:

  • Code blocks / raw tags uniformisation for better source readability
  • highlight liquid rather than html in code blocks
  • Tip: jekyll-paginate-v2 for pagination
  • Tip: jekyll-livereload for serve
  • update Shopify Liquid Help URL
  • remove obsolete site.help_url
Docs: updates
- Code blocks
- Tip:  Jekyll-paginate-v2
- Tip: jekyll-livereload
- Shopify Liquid Help
- Help URL

@DirtyF DirtyF added the documentation label Oct 2, 2017

@DirtyF DirtyF requested a review from jekyll/documentation Oct 2, 2017

@parkr

parkr approved these changes Oct 3, 2017

Nice!

<pre class="highlight"><code>$ script/bootstrap</code></pre>
```sh
script/bootstrap
```

This comment has been minimized.

@parkr

parkr Oct 3, 2017

Member

I believe this page is generated, so this will have to be updated in .github/CONTRIBUTING.md. I may be wrong though!

@parkr

parkr Oct 3, 2017

Member

I believe this page is generated, so this will have to be updated in .github/CONTRIBUTING.md. I may be wrong though!

{% for post in site.categories[page.category] %}
<a href="{{ post.url | prepend: site.baseurl }}">
<a href="{{ post.url | absolute_url }}">

This comment has been minimized.

@parkr

parkr Oct 3, 2017

Member

This makes it | prepend: site.baseurl | prepend: site.url which is technically a change in behaviour. Just noting it. 🤷‍♂️

@parkr

parkr Oct 3, 2017

Member

This makes it | prepend: site.baseurl | prepend: site.url which is technically a change in behaviour. Just noting it. 🤷‍♂️

This comment has been minimized.

@DirtyF

DirtyF Oct 3, 2017

Member

True, I thought we should encourage the use of the filter in our docs. Should we?
There is no URLs good practices in http://ben.balter.com/jekyll-style-guide/ yet but it might be a good candidate.

@DirtyF

DirtyF Oct 3, 2017

Member

True, I thought we should encourage the use of the filter in our docs. Should we?
There is no URLs good practices in http://ben.balter.com/jekyll-style-guide/ yet but it might be a good candidate.

Show outdated Hide outdated docs/_docs/themes.md Outdated
Show outdated Hide outdated docs/_docs/windows.md Outdated
@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Oct 3, 2017

Member

@jekyllbot: merge +docs

Member

DirtyF commented Oct 3, 2017

@jekyllbot: merge +docs

@jekyllbot jekyllbot merged commit 85aebe9 into master Oct 3, 2017

0 of 2 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

@jekyllbot jekyllbot deleted the docs-fenced-blocks branch Oct 3, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment