Skip to content

Docs: Add code examples section#22974

Merged
mkaz merged 4 commits intomasterfrom
add/docs-code-ex
Jun 7, 2020
Merged

Docs: Add code examples section#22974
mkaz merged 4 commits intomasterfrom
add/docs-code-ex

Conversation

@mkaz
Copy link
Copy Markdown
Member

@mkaz mkaz commented Jun 6, 2020

Description

Adds a code example section to the Documentation contributors page that explains how to use the triple tick marks and code tabs.

This also clarifies the preference for ESNext as the default codetab, this was discussed in #17873 and in core-editor chat

How has this been tested?

Confirm code markup doesn't get wonky, it's tricky to document code using the format used to document code. You can view rendered on the branch here.

It looks fine in Github but will it survive handbook conversion 🤞

Types of changes

Documentation.

@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Jun 6, 2020
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 6, 2020

Size Change: +807 B (0%)

Total Size: 1.13 MB

Filename Size Change
build/a11y/index.js 1.14 kB +1 B
build/annotations/index.js 3.62 kB +2 B (0%)
build/autop/index.js 2.83 kB +1 B
build/block-directory/index.js 6.75 kB -1 B
build/block-editor/index.js 106 kB +6 B (0%)
build/block-library/index.js 127 kB -21 B (0%)
build/block-serialization-default-parser/index.js 1.88 kB -2 B (0%)
build/block-serialization-spec-parser/index.js 3.1 kB +1 B
build/blocks/index.js 48.1 kB +3 B (0%)
build/components/index.js 194 kB +802 B (0%)
build/core-data/index.js 11.4 kB +4 B (0%)
build/data/index.js 8.45 kB -1 B
build/date/index.js 5.47 kB +2 B (0%)
build/dom-ready/index.js 569 B +1 B
build/edit-post/index.js 303 kB +1 B
build/edit-site/index.js 15.5 kB +2 B (0%)
build/edit-widgets/index.js 9.34 kB +4 B (0%)
build/editor/index.js 44.7 kB +2 B (0%)
build/format-library/index.js 7.72 kB +3 B (0%)
build/hooks/index.js 2.13 kB -3 B (0%)
build/i18n/index.js 3.56 kB +1 B
build/keyboard-shortcuts/index.js 2.51 kB -1 B
build/media-utils/index.js 5.3 kB +2 B (0%)
build/notices/index.js 1.79 kB +1 B
build/nux/index.js 3.41 kB +1 B
build/plugins/index.js 2.56 kB +1 B
build/primitives/index.js 1.5 kB -2 B (0%)
build/redux-routine/index.js 2.85 kB -1 B
build/server-side-render/index.js 2.68 kB +1 B
build/token-list/index.js 1.28 kB -1 B
build/viewport/index.js 1.85 kB -1 B
build/wordcount/index.js 1.17 kB -1 B
ℹ️ View Unchanged
Filename Size Change
build/api-fetch/index.js 3.4 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/style-rtl.css 892 B 0 B
build/block-directory/style.css 892 B 0 B
build/block-editor/style-rtl.css 11.4 kB 0 B
build/block-editor/style.css 11.4 kB 0 B
build/block-library/editor-rtl.css 7.87 kB 0 B
build/block-library/editor.css 7.87 kB 0 B
build/block-library/style-rtl.css 7.72 kB 0 B
build/block-library/style.css 7.72 kB 0 B
build/block-library/theme-rtl.css 684 B 0 B
build/block-library/theme.css 686 B 0 B
build/components/style-rtl.css 19.5 kB 0 B
build/components/style.css 19.5 kB 0 B
build/compose/index.js 9.31 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/deprecated/index.js 771 B 0 B
build/dom/index.js 3.17 kB 0 B
build/edit-navigation/index.js 8.25 kB 0 B
build/edit-navigation/style-rtl.css 918 B 0 B
build/edit-navigation/style.css 919 B 0 B
build/edit-post/style-rtl.css 5.43 kB 0 B
build/edit-post/style.css 5.43 kB 0 B
build/edit-site/style-rtl.css 2.96 kB 0 B
build/edit-site/style.css 2.96 kB 0 B
build/edit-widgets/style-rtl.css 2.4 kB 0 B
build/edit-widgets/style.css 2.4 kB 0 B
build/editor/editor-styles-rtl.css 425 B 0 B
build/editor/editor-styles.css 428 B 0 B
build/editor/style-rtl.css 4.26 kB 0 B
build/editor/style.css 4.27 kB 0 B
build/element/index.js 4.64 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/html-entities/index.js 621 B 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.12 kB 0 B
build/list-reusable-blocks/style-rtl.css 226 B 0 B
build/list-reusable-blocks/style.css 226 B 0 B
build/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/priority-queue/index.js 789 B 0 B
build/rich-text/index.js 14.8 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/url/index.js 4.06 kB 0 B
build/warning/index.js 1.14 kB 0 B

compressed-size-action

Comment thread docs/contributors/document.md Outdated
Comment thread docs/contributors/document.md Outdated
Comment thread docs/contributors/document.md Outdated
mkaz and others added 2 commits June 6, 2020 15:25
Co-authored-by: Dominik Schilling <dominikschilling+git@gmail.com>
@mkaz mkaz merged commit c96792a into master Jun 7, 2020
@mkaz mkaz deleted the add/docs-code-ex branch June 7, 2020 13:32
@github-actions github-actions Bot added this to the Gutenberg 8.3 milestone Jun 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants