Skip to content
This repository has been archived by the owner on Jan 19, 2023. It is now read-only.

Commit

Permalink
Fix code wrap, deep link to Slack, header links
Browse files Browse the repository at this point in the history
Signed-off-by: jonasrosland <[email protected]>
  • Loading branch information
jonasrosland committed Oct 24, 2019
1 parent 92a8f1d commit 4db5dee
Show file tree
Hide file tree
Showing 5 changed files with 117 additions and 13 deletions.
14 changes: 7 additions & 7 deletions site/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ title: Octant
email:
author: Octant Authors
description: Validate your Kubernetes configuration
url: https://github.com/vmware/octant
#url: https://octant.dev
logo: octant-logo.png
twitter:
username: projectoctant
card: summary
vm_logo: vm-logo.png
gh_repo: https://github.com/vmware/octant
gh_repo: https://github.com/vmware-tanzu/octant
markdown: redcarpet
hero:
background-color: darkest-blue
background-color: med-blue
footer:
title: Getting Started
content: To help you get started, see the documentation.
Expand All @@ -24,16 +24,16 @@ footer:
footer_social_links:
Twitter:
fa_icon: fab fa-twitter
url: https://github.com/vmware/octant
url: https://twitter.com/projectoctant
Slack:
fa_icon: fab fa-slack
url: https://kubernetes.slack.com/messages/CM37M9FCG
url: https://kubernetes.slack.com/app_redirect?channel=CM37M9FCG
RSS:
fa_icon: fa fa-rss
url: feed.xml
GitHub:
fa_icon: fab fa-github
url: https://github.com/vmware/octant
url: https://github.com/vmware-tanzu/octant

defaults:
- scope:
Expand All @@ -50,7 +50,7 @@ defaults:
path: docs/master
values:
version: master
gh: https://github.com/vmware/octant/tree/master
gh: https://github.com/vmware-tanzu/octant/tree/master
layout: "docs"

page_gen:
Expand Down
105 changes: 105 additions & 0 deletions site/_includes/anchor_headings.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
{% capture headingsWorkspace %}
{% comment %}
Version 1.0.4
https://github.com/allejo/jekyll-anchor-headings

"Be the pull request you wish to see in the world." ~Ben Balter

Usage:
{% include anchor_headings.html html=content %}

Parameters:
* html (string) - the HTML of compiled markdown generated by kramdown in Jekyll

Optional Parameters:
* beforeHeading (bool) : false - Set to true if the anchor should be placed _before_ the heading's content
* anchorAttrs (string) : '' - Any custom HTML attributes that will be added to the `<a>` tag; you may NOT use `href`, `class` or `title`
* anchorBody (string) : '' - The content that will be placed inside the anchor; the `%heading%` placeholder is available
* anchorClass (string) : '' - The class(es) that will be used for each anchor. Separate multiple classes with a space
* anchorTitle (string) : '' - The `title` attribute that will be used for anchors
* h_min (int) : 1 - The minimum header level to build an anchor for; any header lower than this value will be ignored
* h_max (int) : 6 - The maximum header level to build an anchor for; any header greater than this value will be ignored
* bodyPrefix (string) : '' - Anything that should be inserted inside of the heading tag _before_ its anchor and content
* bodySuffix (string) : '' - Anything that should be inserted inside of the heading tag _after_ its anchor and content

Output:
The original HTML with the addition of anchors inside of all of the h1-h6 headings.
{% endcomment %}

{% assign minHeader = include.h_min | default: 1 %}
{% assign maxHeader = include.h_max | default: 6 %}
{% assign beforeHeading = include.beforeHeading %}
{% assign nodes = include.html | split: '<h' %}

{% capture edited_headings %}{% endcapture %}

{% for _node in nodes %}
{% capture node %}{{ _node | strip }}{% endcapture %}

{% if node == "" %}
{% continue %}
{% endif %}

{% assign nextChar = node | replace: '"', '' | strip | slice: 0, 1 %}
{% assign headerLevel = nextChar | times: 1 %}

<!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's try to fix it -->
{% if headerLevel == 0 %}
{% if nextChar != '<' and nextChar != '' %}
{% capture node %}<h{{ node }}{% endcapture %}
{% endif %}

{% capture edited_headings %}{{ edited_headings }}{{ node }}{% endcapture %}
{% continue %}
{% endif %}

{% assign _workspace = node | split: '</h' %}
{% assign _idWorkspace = _workspace[0] | split: 'id="' %}
{% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
{% assign html_id = _idWorkspace[0] %}

{% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
{% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}

<!-- Build the anchor to inject for our heading -->
{% capture anchor %}{% endcapture %}

{% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %}
{% capture anchor %}href="#{{ html_id }}"{% endcapture %}

{% if include.anchorClass %}
{% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %}
{% endif %}

{% if include.anchorTitle %}
{% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', header }}"{% endcapture %}
{% endif %}

{% if include.anchorAttrs %}
{% capture anchor %}{{ anchor }} {{ include.anchorAttrs }}{% endcapture %}
{% endif %}

{% capture anchor %}<a {{ anchor }}>{{ include.anchorBody | replace: '%heading%', header | default: '' }}</a>{% endcapture %}

<!-- In order to prevent adding extra space after a heading, we'll let the 'anchor' value contain it -->
{% if beforeHeading %}
{% capture anchor %}{{ anchor }} {% endcapture %}
{% else %}
{% capture anchor %} {{ anchor }}{% endcapture %}
{% endif %}
{% endif %}

{% capture new_heading %}
<h{{ _hAttrToStrip }}
{{ include.bodyPrefix }}
{% if beforeHeading %}
{{ anchor }}{{ header }}
{% else %}
{{ header }}{{ anchor }}
{% endif %}
{{ include.bodySuffix }}
</h{{ _workspace | last }}
{% endcapture %}
{% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %}
{% endfor %}
{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}
4 changes: 1 addition & 3 deletions site/_layouts/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,11 @@ <h1>Documentation</h1>
<div class="container container-max">
<div class="row">
<div class="col-md-3 toc">
{% include versions.html %}
{% include nav.html %}
</div>
<div class="col-md-8">
{% include version-warning.html %}
<div class="documentation-container">
{{ content }}
{% include anchor_headings.html html=content %}
</div>
</div>
</div>
Expand Down
1 change: 1 addition & 0 deletions site/_scss/site/common/_type.scss
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ pre {
padding-bottom: 5px;
padding-left: 5px;
padding-right: 5px;
white-space: pre-wrap;


// Account for some code outputs that place code tags in pre tags
Expand Down
6 changes: 3 additions & 3 deletions site/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ If you’re a newcomer, check out the “[Good first issue](https://github.com/v
You can follow the work we do, see our milestones, and examine our backlog on our [ZenHub board](https://app.zenhub.com/workspaces/octant-5ba2bc534b5806bc2be8fa8d/board).

* Follow us on Twitter at [@projectoctant](https://twitter.com/projectoctant)
* Join our Kubernetes Slack channel and talk to over 300 other community members: [#octant](https://kubernetes.slack.com/messages/CM37M9FCG)
* Join our Kubernetes Slack channel and talk to us and other community members: [#octant](https://kubernetes.slack.com/app_redirect?channel=CM37M9FCG)
* Join our [Google Group](http://groups.google.com/forum/#!forum/project-octant) to get updates on the project and invitations to community meetings.
* Join the Octant community meetings:
* Every 2nd Tuesday - [Zoom link](https://VMware.zoom.us/j/627117615)
* See previous community meetings, demos, and more on our [YouTube Playlist](https://www.youtube.com/playlist?list=PL7bmigfV0EqQ55lLisHHy2n1MDuRZasrR)
* Every 2nd Tuesday - [Zoom link](https://VMware.zoom.us/j/627117615)
* See previous community meetings, demos, and more on our [YouTube Playlist](https://www.youtube.com/playlist?list=PL7bmigfV0EqQ55lLisHHy2n1MDuRZasrR)

0 comments on commit 4db5dee

Please sign in to comment.