updated read me

This commit is contained in:
tomjohnson1492
2016-05-07 12:36:43 -07:00
parent 4063deecea
commit 4780055823
2 changed files with 3 additions and 4 deletions

View File

@ -1,3 +1,3 @@
## Jekyll Documentation theme
This is the readme page of the Jekyll documentation theme.
Build the site to see the instructions for using it. Or just go here: [http://idratherbewriting.com/documentation-theme-jekyll/](idratherbewriting.com/documentation-theme-jekyll/)

View File

@ -131,15 +131,14 @@ Here's how you specify an ID for a heading in Kramdown:
Link to it using this syntax:
```
[{{site.data.urls.your-page-permalink.title}}]({{site.data.urls.your-page-permalink.url | append: "#myheading"}})
{%raw%}[{{site.data.urls.your-page-permalink.title}}]({{site.data.urls.your-page-permalink.url | append: "#myheading"}}){%endraw%}
```
Or using HTML:
```
<a href="{{site.data.urls.your-page-permalink.url | append: "#myheading"}}">{{site.data.urls.your-page-permalink.title}}</a>
{%raw%}<a href="{{site.data.urls.your-page-permalink.url | append: "#myheading"}}">{{site.data.urls.your-page-permalink.title}}</a>{%endraw%}
```
Granted, this is somewhat long, but it's the only way to continue to leverage the automated links from urls.yaml. You want to avoid manually referencing links since they are much more prone to break when you specify them that way.