2022-02-20 15:15:38 +01:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta http-equiv = "X-UA-Compatible" content = "ie=edge" >
2022-07-28 05:28:26 +02:00
< link rel = "stylesheet" href = "../../static/styles.css?h=ae0cc228" >
2022-02-20 15:15:38 +01:00
< link rel = "stylesheet" href = "../../static/pygments.css" >
< link rel = "shortcut icon" href = "../../static/favicon.png?h=fa09bedd" >
< title > | Lektor Static Content Management System< / title >
< / head >
< body class = "default" >
< nav class = "navbar navbar-inverse navbar-static-top" >
< div class = "container" >
< div class = "navbar-header" >
< button type = "button" class = "navbar-toggle collapsed"
data-toggle="collapse" data-target="#navbar"
aria-expanded="false" aria-controls="navbar">
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "navbar-brand" href = "../../" > Lektor< / a >
< / div >
< div id = "navbar" class = "collapse navbar-collapse" >
< ul class = "nav navbar-nav" >
< li > < a href = "../../downloads/" > Download< / a > < / li >
< li > < a href = "../../docs/" > Documentation< / a > < / li >
< li > < a href = "../../showcase/" > Showcase< / a > < / li >
< li class = "active" > < a href = "../" > Plugins< / a > < / li >
< li > < a href = "../../community/" > Community< / a > < / li >
< li > < a href = "../../blog/" > Blog< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< div class = "body-wrapper" >
< div class = "page-banner page-banner-300" style = "background-image: url(../header.jpg)" > < / div >
< div class = "container" >
<!-- Place this tag in your head or just before your close body tag. -->
< div class = "plugin" >
< div class = "row" >
< div class = "col-sm-12" >
< h1 > Plugin – lektor-markdown-header-anchors 0.3.1< / h1 >
< / div >
< / div >
< div class = "row" >
< div class = "col-sm-1" > < / div >
< div class = "col-sm-11" >
< p > Lektor plugin that adds anchors and table of contents to markdown headers.< p >
< / div >
< / div >
< div class = "row" >
< div class = "col-sm-3 plugin-margin" >
< h4 > Project links< / h4 >
< ul class = "tree-nav" >
< li > < a href = "http://github.com/lektor/lektor-markdown-header-anchors" class = "ext" > Homepage< / a > < / li >
< / ul >
< div class = "separator" >
< h4 > GitHub Statistics< / h4 >
< / div >
< ul class = "button-nav" >
< li > < p > < a class = "github-button" href = "http://github.com/lektor/lektor-markdown-header-anchors" data-icon = "octicon-star" data-size = "large" data-show-count = "true" aria-label = "Star lektor-markdown-header-anchors on GitHub" target = "_blank" > Star< / a > < / p > < / li >
< li > < p > < a class = "github-button" href = "http://github.com/lektor/lektor-markdown-header-anchors/fork" data-icon = "octicon-repo-forked" data-show-count = "true" data-size = "large" data-show = "true" aria-label = "Open Issues" target = "_blank" > Fork< / a > < / p > < / li >
< li > < p > < a class = "github-button" href = "http://github.com/lektor/lektor-markdown-header-anchors/issues" data-icon = "octicon-issue-opened" data-show-count = "true" data-size = "large" data-show = "true" aria-label = "Open Issues" target = "_blank" > Open Issues< / a > < / p > < / li >
< / ul >
< div class = "separator" >
< h4 > Meta< / h4 >
< / div >
< p > < strong > Version:< / strong > 0.3.1< / p >
< p > < strong > Author:< / strong >
< a href = "mailto:armin.ronacher@active-4.com" > Armin Ronacher< / a >
< / p >
< div class = "separator" >
< h4 > Tags< / h4 >
< / div >
< a href = "../tag/anchors/" > anchors< / a > ,
< a href = "../tag/headers/" > headers< / a > ,
< a href = "../tag/Markdown/" > Markdown< / a > ,
< a href = "../tag/markdown-config/" > markdown-config< / a > ,
< a href = "../tag/markdown-meta-init/" > markdown-meta-init< / a > ,
< a href = "../tag/markdown-meta-postprocess/" > markdown-meta-postprocess< / a > ,
< a href = "../tag/official/" > official< / a > ,
and
< a href = "../tag/table-of-contents/" > table of contents< / a >
2022-02-24 02:43:35 +01:00
< p >
View < a href = "../tags/" class = "ref" > all tags< / a > .
< / p >
2022-02-20 15:15:38 +01:00
< / div >
< div class = "col-sm-9 doc-styling" >
< h2 > Project Description< / h2 >
< h1 > lektor-markdown-header-anchors< / h1 >
< p > This plugin extends the markdown support in Lektor in a way that headlines
are given anchors and a table of contents is collected.< / p >
< h2 > Enabling the Plugin< / h2 >
< p > To enable the plugin run this command:< / p >
2022-08-07 05:06:28 +02:00
< pre lang = "shell" > $ lektor plugins add markdown-header-anchors
2022-02-20 15:15:38 +01:00
< / pre >
< h2 > In Templates< / h2 >
< p > Within templates it becomes possible to access the < code > .toc< / code > property of
markdown data. It's a list where each item has the following attributes:< / p >
< ul >
< li > < code > anchor< / code > : the name of the anchor< / li >
< li > < code > title< / code > : the title of the headline as HTML< / li >
< li > < code > children< / code > : a list of headers below that header< / li >
< / ul >
< p > Example rendering:< / p >
2022-08-07 05:06:28 +02:00
< pre lang = "jinja" > < span class = "x" > < h4> Table Of Contents< /h4> < / span >
2022-02-20 15:15:38 +01:00
< span class = "x" > < ul class=" toc" > < / span >
< span class = "cp" > {%< / span > < span class = "k" > for< / span > < span class = "nv" > item< / span > < span class = "k" > in< / span > < span class = "nv" > this.body.toc< / span > < span class = "k" > recursive< / span > < span class = "cp" > %}< / span > < span class = "x" > < / span >
< span class = "x" > < li> < a href=" #< / span > < span class = "cp" > {{< / span > < span class = "nv" > item.anchor< / span > < span class = "cp" > }}< / span > < span class = "x" > " > < / span > < span class = "cp" > {{< / span > < span class = "nv" > item.title< / span > < span class = "cp" > }}< / span > < span class = "x" > < /a> < / span > < span class = "cp" > {%< / span >
< span class = "k" > if< / span > < span class = "nv" > item.children< / span > < span class = "cp" > %}< / span > < span class = "x" > < ul> < / span > < span class = "cp" > {{< / span > < span class = "nb" > loop< / span > < span class = "o" > (< / span > < span class = "nv" > item.children< / span > < span class = "o" > )< / span > < span class = "cp" > }}< / span > < span class = "x" > < /ul> < / span > < span class = "cp" > {%< / span > < span class = "k" > endif< / span > < span class = "cp" > %}< / span > < span class = "x" > < /li> < / span >
< span class = "cp" > {%< / span > < span class = "k" > endfor< / span > < span class = "cp" > %}< / span > < span class = "x" > < / span >
< span class = "x" > < /ul> < / span >
< / pre >
< div class = "comment-box" >
< h2 > Comments< / h2 >
< div id = "disqus_thread" > < / div >
< script >
var disqus_config = function() { this.page.identifier = "/plugins/lektor-markdown-header-anchors"; this.page.url = "https://www.getlektor.com/plugins/lektor-markdown-header-anchors/"; };
(function() {
var d = document, s = d.createElement('script');
s.src = '//lektordocumentation.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
< / script >
< noscript >
Please enable JavaScript to view the < a href = "https://disqus.com/?ref_noscript"
rel="nofollow">comments powered by Disqus.< / a >
< / noscript >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "bottomsummary" >
< div class = "container" >
< / div >
< / div >
< footer >
< div class = "container" >
< div class = "row" >
< div class = "col-sm-4 icon-bar" >
< a href = "https://github.com/lektor/lektor/" title = "Lektor on GitHub"
>< i class = "fa fa-github" > < / i > < / a >
< a href = "https://github.com/lektor/lektor/issues/" title = "Report Issues for Lektor"
>< i class = "fa fa-bug" > < / i > < / a >
< a href = "https://twitter.com/getlektor" title = "Find Lektor on Twitter"
>< i class = "fa fa-twitter" > < / i > < / a >
< a href = "https://gitter.im/lektor/lektor" title = "Chat on Gitter"
>< i class = "fa fa-comment" > < / i > < / a >
< a href = "https://github.com/lektor/lektor-website/tree/master/content/plugins/lektor-markdown-header-anchors/contents.lr" title = "View source for this page" > < i class = "fa fa-code" > < / i > < / a >
< / div >
< div class = "col-sm-8" >
< a href = "../../license/" > License & Copyright< / a > •
< a href = "../../contact/" > Contact< / a > •
Made with < i class = "fa fa-fw fa-heart" title = "Heart" > < span hidden > Heart< / span > < / i > in Carinthia
< / div >
< / div >
< / div >
< / footer >
< script type = text/javascript src = "../../static/app.js?h=bb1b933a" charset = "utf-8" > < / script >
< script >
((window.gitter = {}).chat = {}).options = {
room: 'lektor/lektor',
activationElement: null
};
document.write('< button class = "js-gitter-toggle-chat-button" > Toggle Chat< / button > ');
var dnt = navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack;
if (dnt != "1" & & dnt != "yes") {
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga('create', 'UA-70822533-1', 'auto');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
} else {
console.debug("Respecting Do-Not-Track, not running analytics.");
}
< / script >
< script async src = 'https://www.google-analytics.com/analytics.js' > < / script >
< script async defer id = "github-bjs" src = "https://buttons.github.io/buttons.js" > < / script >
< script > ! function ( d , s , id ) { var js , fjs = d . getElementsByTagName ( s ) [ 0 ] , p = /^http:/ . test ( d . location ) ? 'http' : 'https' ; if ( ! d . getElementById ( id ) ) { js = d . createElement ( s ) ; js . id = id ; js . src = p + '://platform.twitter.com/widgets.js' ; fjs . parentNode . insertBefore ( js , fjs ) ; } } ( document , 'script' , 'twitter-wjs' ) ; < / script >
< script src = "https://sidecar.gitter.im/dist/sidecar.v1.js" async defer > < / script >
< / body >
< / html >
