kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
website/content/en/docs/doc-contributor-tools/snippets
History
Misty Linville 5ae0d0dd8d Reorganize docs contrib guide (#9510) 
* Reorganize docs contrib guide

* Address first round of feedback from Brad, Jared

* Standardize on 'SIG Docs'

* Address more feedback

* Rewrites to participating.md

* Tweak navigation titles

* Document PR Wrangler

* Document SIG Docs chairperson

* Fix codeblock that shows how to use <codenew>

It was being interpreted as a Hugo shortcode.
 		2018-08-06 16:15:57 -07:00
..
README.md Reorganize docs contrib guide (#9510) 2018-08-06 16:15:57 -07:00
atom-snippets.cson Add Atom snippets file (#9158) 2018-07-12 15:01:26 -07:00

README.md

Snippets for Atom

Snippets are bits of text that get inserted into your editor, to save typing and reduce syntax errors. The snippets provided in atom-snippets.cson are scoped to only work on Markdown files within Atom.

Installation

Copy the contents of the atom-snippets.cson file into your existing ~/.atom/snippets.cson. Do not replace your existing file.

You do not need to restart Atom.

Usage

Have a look through atom-snippets.cson and note the titles and prefix values of the snippets.

You can trigger a given snippet in one of two ways:

  • By typing the snippet's prefix and pressing the <TAB> key
  • By searching for the snippet's title in Packages / Snippets / Available

For example, open a Markdown file and type anote and press <TAB>. A blank note is added, with the correct Hugo shortcodes.

A snippet can insert a single line or multiple lines of text. Some snippets have placeholder values. To get to the next placeholder, press <TAB> again.

Some of the snippets only insert partially-formed Markdown or Hugo syntax. For instance, coverview inserts the start of a concept overview tag, while cclose inserts a close-capture tag. This is because every type of capture needs a capture-close tab.

Creating new topics using snippets

To create a new concept, task, or tutorial from a blank file, use one of the following:

  • newconcept
  • newtask
  • newtutorial

Placeholder text is included.

Submitting new snippets

  1. Develop the snippet locally and verify that it works as expected.
  2. Copy the template's code into the atom-snippets.cson file on Github. Raise a pull request, and ask for review from another Atom user in #sig-docs on Kubernetes Slack.