| layout | collection | title | permalink | sticky_sidenav | sidenav | subnav | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page |
Page title |
Page Link |
true |
|
Markdown is a simple way of writing and formatting. The formats can be used across many different platforms including for websites and documents. We created a sample template to help you with your page.
Review information on how to contribute and how to Add a New Page. If you want to learn more about markdown formatting: https://guides.github.com/features/mastering-markdown/
You can copy and paste this template into a new page, and use the sample markdown.
You probably noticed this block at the top of the page.
layout: default title: Title of the Page permalink: /template/
This block at the top of the page, called Front Matter, is used for website navigation when your guide is posted. Update the Title of the Page and the /template/
For more information on using different jekyll format or web design features:
- Federalist Jekyll - https://github.com/18F/federalist-uswds-jekyll/blob/main/README.md
- U.S. Web Design Standard - https://designsystem.digital.gov
- U.S. Web Design Standard Jekyll - https://github.com/18F/uswds-jekyll
To begin your guide, briefly state its purpose in one to two sentences for an Overview. You may include information on the intended audience, the intended outcome of the guide, and any other information that would help the user to understand the guide.
Then add a table of contents link for each section. For example:
We propose these sections for most guides:
This section should tell the user what to prepare before starting a set of procedures. Explain any assumptions as bulleted lists. Clearly state the hardware and software requirements.
This section should tell the user how to achieve the goal. Explain all steps simply and don't try to recreate other resources that are easily found. Focus on the government and what can be unique when implementing or executing.
This section should tell the user how to achieve the goal. Explain all steps simply and don't try to recreate other resources that are easily found. Focus on the government and what can be unique when implementing or executing.
Here are sample markdown formats for you:
Headings use the hash sign with a space.
- Step 1 of procedure. (Indent 2 spaces, enter a number, and add 1 space.)
- Step 2 of procedure.
- Bullet 1 (Indent 2 spaces, enter an asterisk, and add 1 space.)
- Bullet 2
- Use double asterisks to bold a word: bold.
- Use underscores to create italics: italics.
To create a code block, use spaces, backticks (```), and Returns in this order:
- 4 spaces plus 3 backticks (```) to start the code block
- A Return
- Type or paste in the code that the user needs to enter for a specific step
- Another Return
- 4 spaces plus 3 backticks to end the code block
- Another Return
For example:
Text within three backticks for code or command line samples
Code comments will be invisible in a webpage view, but others will be able to see the comment in GitHub Markdown.
To insert an image into your Page, upload the image file to the /img/ folder in the GitHub repository. Then at the image insertion point in your page, add these formats to link to the image.
To link to useful references, information:
This is what I want my link to say
To link to a document, or to another website, you need to always open the link in a new window:
This is what I want my link to say{:target="_blank"}{:rel="noopener noreferrer"}.