https://github.com/saltstack/salt-get-started

Content source files for the SaltStack Get Started Guide.
https://github.com/saltstack/salt-get-started

Last synced: about 1 month ago
JSON representation

Content source files for the SaltStack Get Started Guide.

• Host: GitHub
• URL: https://github.com/saltstack/salt-get-started
• Owner: saltstack
• Created: 2016-01-04T21:55:14.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-02-02T16:01:30.000Z (almost 2 years ago)
• Last Synced: 2024-09-30T11:17:06.317Z (about 1 month ago)
• Size: 3.4 MB
• Stars: 17
• Watchers: 26
• Forks: 24
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SaltStack Get Started Guide Source

This repository contains the content source files for the [SaltStack Get Started Guide](https://docs.saltstack.com/en/getstarted/).

Contributions to fix typos and other errors are welcome.

## Source File Format

The source files are in [Pandoc's Markdown](http://pandoc.org/README.html#pandocs-markdown) with the `markdown+pipe_tables` & `backtick_code_blocks` extensions enabled.

Code samples that contain Jinja must be wrapped in Jinja `{% raw %}` and `{% endraw %}` statements since the source files are sent though Jinja when the site is generated.

## Preview

There are many tools that can generate a preview from markdown so you can verify formatting, URLs, and so on. If you have [pandoc](http://pandoc.org/) installed, you can quickly generate HTML using a command similar to:

``` bash

pandoc *.md > out.html

```

## YAML Frontmatter

The YAML frontmatter and processing directives can be safely ignored (processing directives are contained within `{: :}`). A few topics contain variables with content for modal windows in the front matter, so there is occasionally a need to make updates here.