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

Header Update #1

Open
wants to merge 43 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
95c24fb
update links
schosterbarak Jan 12, 2020
76f0151
update links
schosterbarak Jan 12, 2020
0d3e0fe
update links
schosterbarak Jan 12, 2020
3b4c266
update links
schosterbarak Jan 12, 2020
732a377
add slack community link
schosterbarak Jan 13, 2020
7cb1de9
Merge pull request #1 from orema10/master
Jan 19, 2020
ac7994a
test search
schosterbarak Jan 21, 2020
05e1b1f
test search
schosterbarak Jan 21, 2020
53a4506
Revert "test search"
schosterbarak Jan 21, 2020
b74616d
Revert "test search"
schosterbarak Jan 21, 2020
a850eca
add search_data.json
schosterbarak Jan 21, 2020
b4cda82
update reference
schosterbarak Mar 10, 2020
e71a0e6
update reference
schosterbarak Mar 10, 2020
ec6d5e0
Create cookie-consent.html
Mar 23, 2020
8259b9e
Update base.html
Mar 23, 2020
fb8b5a7
Rename cookie-consent.html to cookieconsent.html
Mar 23, 2020
320b413
Update base.html
Mar 23, 2020
626a60e
Update base.html
Mar 23, 2020
7f6ae89
Delete cookieconsent.html
Mar 23, 2020
d025f5b
Update footer.html
Mar 23, 2020
23a4221
Update base.html
Mar 23, 2020
6debdce
Update _config.yml
Mar 23, 2020
32c750b
Update _config.yml
Mar 23, 2020
0287253
Update README.md
Mar 23, 2020
54220dd
Create cookie-consent.html
Mar 23, 2020
ef07b44
Create cookieconsent.html
Mar 23, 2020
8f7a048
update reference
schosterbarak Mar 23, 2020
22e81ab
Merge remote-tracking branch 'origin/master'
schosterbarak Mar 23, 2020
e8525e9
update reference
schosterbarak Mar 23, 2020
53d1a9e
fix theme
schosterbarak Mar 23, 2020
9df3628
fix theme
schosterbarak Mar 27, 2020
dcfc7e2
fix theme
schosterbarak Mar 27, 2020
33603b2
fix theme
schosterbarak Mar 27, 2020
1bb8716
fix theme
schosterbarak Mar 27, 2020
f14c8dd
fix theme
schosterbarak Mar 28, 2020
d25719d
fix theme
schosterbarak Mar 28, 2020
d281f2a
fix theme
schosterbarak Mar 28, 2020
4011b6b
fix theme
schosterbarak Mar 28, 2020
6b4b100
fix theme
schosterbarak Mar 28, 2020
eea6aa2
fix theme
schosterbarak Mar 28, 2020
833d9d3
fix theme
schosterbarak Mar 28, 2020
a833bcb
fix theme
schosterbarak Mar 28, 2020
11fa6a3
Header Update
melkor1985 Jul 7, 2020
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
182 changes: 0 additions & 182 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,183 +1 @@
# Read The Docs Theme for Jekyll and GitHub Pages

Port of the Read the Docs theme to Jekyll that can be used with GitHub Pages.

You can preview it in the
[user documentation](https://carlosperate.github.io/jekyll-theme-rtd):

![theme screenshot](docs/assets/img/screenshot.png)

The original [Read The Docs](https://sphinx-rtd-theme.readthedocs.io)
theme was created for [Sphinx](https://www.sphinx-doc.org/), and so it is
designed specifically for documentation.

Combined with [GitHub Pages](https://pages.github.com) it's a great and easy
way to document your projects!

Check out the [quick start guide]() to see how easy it is to

### 🚧 Warning!

This theme is currently a **Work-In-Progress** but, while some things might be
broken, it should be already usable.

Missing features are listed in the GitHub issues with the
[to-do label](https://github.com/carlosperate/jekyll-theme-rtd/issues?q=is%3Aissue+is%3Aopen+label%3Ato-do),
and any known issues are listed with the
[bug label](https://github.com/carlosperate/jekyll-theme-rtd/issues?q=is%3Aissue+is%3Aopen+label%3Abug).

Contributions are very welcomed!


## 🗂️ Readme Contents

This README contains mostly the developer documentation to edit this theme.

To learn how to use this theme for your own website or docs check out the
[user documentation](https://carlosperate.github.io/jekyll-theme-rtd).

- [🚀 Using this theme with GitHub Pages](#-using-this-theme-with-github-pages)
- [👩‍💻 Developer Documentation](#-developer-documentation)
- [Run in a virtual machine with Vagrant](#run-in-a-virtual-machine-with-vagrant)
- [Run locally with Ruby](#run-locally-with-ruby)
- [Build the docs using the remote theme](#build-the-docs-using-the-remote-theme)
- [Build the docs with MkDocs for comparison](#build-the-docs-with-mkdocs-for-comparison)
- [👨‍👩‍👧‍👦 Contributing](#-contributing)
- [⚖️ License](#%EF%B8%8F-license)


## 🚀 Using this theme with GitHub Pages

The fastest way to use this theme is with GitHub Pages, check out the
[Quick Start Guide from the user documentation](https://carlosperate.github.io/jekyll-theme-rtd/quickstart.html).

## 👩‍💻 Developer Documentation

These instructions describe two different ways to to set up your environment to
develop or edit this theme.

The theme is developed like a normal Jekyll site, and it can serve the
documentation using the theme source code located here.

### Run in a virtual machine with Vagrant

[Vagrant](https://www.vagrantup.com) provides an easy way to set up and manage
a Virtual Machine with [VirtualBox](https://www.virtualbox.org). With a single
command you can automatically create the VM with all the dependencies required
to build and sever this project.

There is a [Vagrantfile](Vagrantfile) included to run an Ubuntu VM with Ruby
and Jekyll. To set-up everything and serve the website run:

```bash
$ vagrant up
```

The first time you run this command it will take a bit longer, as it downloads
and installs everything. Subsequent runs will be much quicker.

This will serve the website at [http://localhost:4000](http://localhost:4000)
with a hot-reload enabled, so any changes made on these files will trigger a
rebuild.

#### Other Vagrant commands

To stop the virtual machine first press `Ctrl+C` to end the Jekyll process and
execute in your terminal:

```
$ vagrant halt
```

You can also SSH into the virtual machine with:

```
$ vagrant ssh
```

### Run locally with Ruby

This website has been developed using Ruby v2.5. You can install the
dependencies with:

```bash
$ gem install bundler
$ bundle install
```

### Build the docs using the remote theme

The Jekyll project here is configured with the root of this repository as the
root of the website, so when it is built locally it will see all pages as being
inside a "docs" folder, and therefore in the "docs" category in the left
navigation bar and page URLs.

On the other hand the root of the website built and served with
[GitHub Pages](https://carlosperate.github.io/jekyll-theme-rtd) is the
"docs" folder, so the left navigation bar will show the child folder as
categories and the URLs will be different.

For updating the theme documentation it can be useful to build and sever the
docs folder with the same configuration as GitHub Pages. Of course, this would
mean that the theme used will be the current snapshot of `master` on GitHub
instead of the local files, but that is not important to just preview the docs.

To do this, add the following lines to the `docs/_config.yml` file:

```yml
plugins:
- jekyll-remote-theme
```

Then execute Jekyll from the docs folder:

```
$ vagrant up --no-provision
$ vagrant ssh
(ssh session) $ cd /vagrant/docs
(ssh session) $ bundle exec jekyll serve --host 0.0.0.0 --watch --force_polling
```

### Build the docs with MkDocs for comparison

As this theme has been ported from the MkDocs port, it can be useful to run
MkDocs on the documentation markdown file and compare its output to the Jekyll
output. A `mkdocs.yml` file is included to configure the project.

Pipenv has been used to manage Python dependencies:

```bash
$ pip install pipenv
$ pipenv install
$ pipenv run mkdocs build
$ cd _site_mkdocs
$ pipenv run python -m http.server 8080
```


## 👨‍👩‍👧‍👦 Contributing

Bug reports and pull requests are welcome on GitHub at
https://github.com/carlosperate/jekyll-theme-rtd.

This project is intended to be a safe, welcoming space for collaboration, and
contributors are expected to adhere to the
[Contributor Covenant](http://contributor-covenant.org) code of conduct.


## ⚖️ License

The original theme is from
[Read The Docs](https://github.com/readthedocs/sphinx_rtd_theme). Copyright ©
2013-2018 Dave Snider, Read the Docs, Inc. & contributors, and released under
the [MIT License](LICENSE-rtd).

This theme is based on the [MkDocs](https://github.com/mkdocs/mkdocs)
[`readthedocs` port](https://github.com/mkdocs/mkdocs/tree/1.0.4/mkdocs/themes/readthedocs).
Copyright © 2014, Tom Christie, all rights reserved, and released under the
[BSD 2-Clause "Simplified" License](LICENSE-mkdocs).

The theme modifications to port it Jekyll can be seen
[here](https://github.com/carlosperate/jekyll-theme-rtd/compare/dddce9f13fde24c03aee4533158c43091120d47e...master).
This and all new features are released under the
[BSD 2-Clause "Simplified" License](LICENSE).
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ webrick:

# Theme settings
site_author: Carlos Pereira Atencio
repo_url: 'https://github.com/carlosperate/jekyll-theme-rtd'
repo_url: 'https://github.com/bridgecrewio/checkov-theme/'
edit_on_github: true
github_docs_folder: false
sticky_navigation: true
Expand Down
Empty file added _includes/cookieconsent.html
Empty file.
38 changes: 19 additions & 19 deletions _includes/footer.html
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
<footer class="footer">
<div class="footer-container">
<a href="#" class="footer-logo-wrapper w-inline-block">
<a href="https://bridgecrew.io/?utm_source=checkovio&utm_medium=organic_oss&utm_campaign=checkov" class="footer-logo-wrapper w-inline-block">
<p class="powered-text">Powered By</p>
<img src="http://checkov.dreampyro.com/web/images/logo.svg" class="bridge-logo">
<img src="https://www.checkov.io/web/images/logo.svg" class="bridge-logo">
</a>
<nav class="footer-nav">
<ul class="footer-links-list w-list-unstyled">
<li class="footer-li">
<a href="#" class="footer-link">Slack Community</a>
<a href="https://codified-security.herokuapp.com/" class="footer-link">Slack Community</a>
</li>
<li class="footer-li">
<a href="#" class="footer-link">About Bridgecrew</a>
<a href="https://bridgecrew.io/about/?utm_source=checkovio&utm_medium=organic_oss&utm_campaign=checkov" class="footer-link">About Bridgecrew</a>
</li>
<li class="footer-li">
<a href="#" class="footer-link">Platform</a>
<a href="https://bridgecrew.io/platform/?utm_source=checkovio&utm_medium=organic_oss&utm_campaign=checkov" class="footer-link">Platform</a>
</li>
<li class="footer-li">
<a href="#" class="footer-link">Terms of use</a>
<a href="https://bridgecrew.zendesk.com/hc/en-us/articles/360008803839-Website-Terms-of-Use" class="footer-link">Terms of use</a>
</li>
<li class="footer-li">
<a href="#" class="footer-link">GitHub</a>
<a href="https://github.com/bridgecrewio/checkov" class="footer-link">GitHub</a>
</li>
<li class="footer-li">
<a href="#" class="footer-link">Our Services</a>
<a href="https://bridgecrew.io/services/?utm_source=checkovio&utm_medium=organic_oss&utm_campaign=checkov" class="footer-link">Our Services</a>
</li>
<li class="footer-li">
<a href="#" class="footer-link">Contact Us</a>
<a href="https://bridgecrew.io/about/?utm_source=checkovio&utm_medium=organic_oss&utm_campaign=checkov" class="footer-link">Contact Us</a>
</li>
<li class="footer-li">
<a href="#" class="footer-link">Privacy policy</a>
<a href="https://bridgecrew.zendesk.com/hc/en-us/articles/360008803379-Privacy-Policy" class="footer-link">Privacy policy</a>
</li>
</ul>
</nav>
<div class="footer-visit-on">
<p class="visit-on-text">Visit us on</p>
<div class="social-links">
<a href="#" class="single-social-link first w-inline-block">
<img src="http://checkov.dreampyro.com/web/images/Fill44.svg" class="social-img">
<a href="https://twitter.com/bridgecrewio" class="single-social-link first w-inline-block">
<img src="https://www.checkov.io/web/images/Fill44.svg" class="social-img">
</a>
<a href="#" class="single-social-link w-inline-block">
<img src="http://checkov.dreampyro.com/web/images/Path870.svg" class="social-img">
<a href="https://www.facebook.com/Bridgecrew-345809279464232" class="single-social-link w-inline-block">
<img src="https://www.checkov.io/web/images/Path870.svg" class="social-img">
</a>
<a href="#" class="single-social-link w-inline-block">
<img src="http://checkov.dreampyro.com/web/images/Group253.svg" class="social-img">
<a href="https://www.linkedin.com/company/bridgecrew" class="single-social-link w-inline-block">
<img src="https://www.checkov.io/web/images/Group253.svg" class="social-img">
</a>
<a href="#" class="single-social-link last w-inline-block">
<img src="http://checkov.dreampyro.com/web/images/Group254.svg" class="social-img">
<a href="https://github.com/bridgecrewio/checkov" class="single-social-link last w-inline-block">
<img src="https://www.checkov.io/web/images/Group254.svg" class="social-img">
</a>
</div>
</div>
</div>
</footer>
</footer>
23 changes: 19 additions & 4 deletions _includes/header.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
<header class="header">

<div class="header-bridgecrew">
<div class="header-container">
<a href="https://bridgecrew.io" target="_blank" class="logo-wrapper">
<img height="35px" width="auto" alt="Bridgecrew.io" src="{{site.baseurl}}/assets/img/logo-white.png">
</a>

<div class="btns-container in-header">
<a class="link" href="https://bridgecrew.io" target="_blank">Learn More</a>
<a class="btn" href="https://www.bridgecrew.cloud/login/signUp" target="_blank">Get started for free</a>
</div>

</div>
</div>

<div class="header-container">
<a href="https://checkov.dreampyro.com/web" target="_blank" class="logo-wrapper">
<img src="http://checkov.dreampyro.com/web/images/checkov-logo.svg" class="image">
<a href="https://www.checkov.io/" target="_blank" class="logo-wrapper">
<img src="https://www.checkov.io/web/images/checkov-logo.svg" class="image">
</a>
<div class="btns-container in-header">
<a href="#" class="button shadow-none">Install</a>
<a href="#" class="button shadow-none white-btn try-bc-btn">Try Bridgecrew</a>
<a href="https://www.checkov.io/1.Introduction/Getting%20Started.html" class="button shadow-none">Install</a>
<a href="https://www.bridgecrew.cloud/login/signUp/?utm_source=checkovio&utm_medium=organic_oss&utm_campaign=checkov" class="button shadow-none white-btn try-bc-btn">Try Bridgecrew</a>
</div>
<i class="fa fa-bars"></i>
</div>
Expand Down
32 changes: 32 additions & 0 deletions _includes/search_data.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
layout: null
nav_exclude: true
search_exclude: true
---
{
{%- for site_page in site.pages %}
{%- unless site_page.search_exclude == true %}
"{{ site_page.url | slugify }}": {
"title": "{{ site_page.title | xml_escape }}",
"content": {{site_page.content | markdownify | newline_to_br | replace: '<br />', ' ' | strip_html | normalize_whitespace | jsonify }},
"url": " {{ site_page.url | xml_escape }}",
"author": "{{ site_page.author | xml_escape }}"
},
{%- endunless %}
{%- endfor %}
{%- for site_post in site.posts %}
{%- unless site_page.search_exclude == true %}
"{{ site_post.url | slugify }}": {
"title": "{{ site_post.title | xml_escape }}",
"content": {{site_post.content | markdownify | newline_to_br | replace: '<br />', ' ' | strip_html | normalize_whitespace | jsonify }},
"url": " {{ site_post.url | xml_escape }}",
"author": "{{ site_post.author | xml_escape }}"
}{%- unless forloop.last %},{%- endunless %}
{%- endunless %}
{%- else %}
{%- comment %} Dirty trick: There is a comma at the end of the sites loop, so we need at least one entry after {% endcomment %}
".": {
".": "."
}
{%- endfor %}
}
Loading