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

Refactor shortguides #1996

Merged
merged 7 commits into from
Aug 24, 2018
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update writer's guide to explain how to use image shortcode for short…
…guides
  • Loading branch information
nmelehan committed Aug 23, 2018
commit e95edd25d13b22c910da4db835ce838c1e554810
6 changes: 6 additions & 0 deletions docs/linode-writers-formatting-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,12 @@ Inserting `headless: true` in the front matter will hide the guide from the site

When using the `content` shortcode in a guide to embed a shortguide, the shortcode will take the name of your guide's directory (e.g. `example-shortguide-name`) as a parameter. A shortguide can be within a different part of the `docs` heirarchy from the guide that embeds it, so the guide directory name exists within a global namespace of all shortguides in the repository. In other words, two different shortguides can't use the same directory name.

To use an image in a shortguide, add the image to your shortguide's directory and then use the `image` shortcode to embed it:

{{< file "sample_embedding_guide/index.md" text >}}
{{</* image src="image-name.png" alt="image alt label" title="image title" */>}}
{{< /file >}}

#### Example Usage

The following shortguide describes how to install Python via Miniconda. Create a directory named `install_python_miniconda` and filed named `index.md` within it:
Expand Down