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

Add file example formatting to code blocks #138

Open
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
3 participants
@rgee0
Copy link
Member

rgee0 commented Mar 12, 2019

Signed-off-by: Richard Gee richard@technologee.co.uk

Description

Initial sweep to add example file headings to code blocks as described in #134.
Standardises how files are described (removes early filename.ext notation)
Some smaller code blocks have been omitted at this stage. These can be reviewed and, if necessary, picked up in a later change.

Motivation and Context

  • I have raised an issue to propose this change (Fixes #134)

How Has This Been Tested?

Review netlify preview link on raising of PR
https://deploy-preview-138--openfaas.netlify.com/conceptual/
image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s
- debug
- dev
```
!!! example "stack.yml"

This comment has been minimized.

@alexellis

alexellis Mar 12, 2019

Member

New one on me. Is the indentation needed?

This comment has been minimized.

@rgee0

rgee0 Mar 12, 2019

Author Member

Apparently. Additionally it seems I may not have indented enough - https://deploy-preview-138--openfaas.netlify.com/conceptual/ shows an example with the correct indentation

@rgee0 rgee0 changed the title Add file example formatting to code blocks [WIP] Add file example formatting to code blocks Mar 12, 2019

Add file example formatting to code blocks
Signed-off-by: Richard Gee <richard@technologee.co.uk>

@rgee0 rgee0 force-pushed the rgee0:addFileExamples branch from 3443030 to 9a05f79 Mar 12, 2019

@rgee0 rgee0 changed the title [WIP] Add file example formatting to code blocks Add file example formatting to code blocks Mar 12, 2019

@burtonr

This comment has been minimized.

Copy link
Member

burtonr commented Mar 12, 2019

This looks really good! It really makes a big difference in some of the "Reference" pages where the files stick out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.