Skip to content

Commit 64757aa

Browse files
theogftheogf
committed
Basic Structure for the website
1 parent 0e58e04 commit 64757aa

File tree

183 files changed

+8331
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

183 files changed

+8331
-0
lines changed

‎.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
page/* linguist-vendored

‎.github/workflows/DeployPage.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Build and Deploy
2+
on:
3+
push:
4+
branches:
5+
- master
6+
jobs:
7+
build-and-deploy:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v2
12+
with:
13+
persist-credentials: false
14+
- name: Install SSH Client
15+
continue-on-error: true
16+
uses: webfactory/[email protected]
17+
with:
18+
ssh-private-key: ${{ secrets.FRANKLIN_PRIV }}
19+
# NOTE: uncomment the following lines if you intend to use PyPlot
20+
# - name: Install python
21+
# uses: actions/setup-python@v1
22+
# with:
23+
# python-version: '3.x'
24+
# - run: pip install matplotlib
25+
- name: Install Julia
26+
uses: julia-actions/setup-julia@v1
27+
with:
28+
version: 1.4
29+
# NOTE
30+
# Adjust the `input=""` on the last line to indicate where
31+
# the source of the package page is (`page/` by default).
32+
#
33+
# Adjust also `output=""` on the last line if you want
34+
# the page to be deployed in a specific folder on gh-pages
35+
# if you do that, make sure that you adjust the `prepath`
36+
# variable in `config.md` accordingly! so for instance
37+
# if you set here `folder="web"` change prepath for
38+
# `@def prepath = "YourPackage.jl/web"`
39+
- run: julia -e '
40+
using Pkg;
41+
Pkg.add(["NodeJS", "PkgPage", "DataFrames"]);
42+
using NodeJS;
43+
run(`$(npm_cmd()) install highlight.js purgecss`);
44+
import PkgPage;
45+
PkgPage.optimize(input="page", output="")'
46+
- name: Build and Deploy
47+
uses: JamesIves/github-pages-deploy-action@releases/v3
48+
with:
49+
SSH: true
50+
BRANCH: gh-pages
51+
FOLDER: page/__site

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
page/__site

‎page/Project.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[deps]
2+
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
3+
Franklin = "713c75ef-9fc9-4b05-94a9-213340da978e"
4+
PkgPage = "e7214860-93a8-4f22-b43d-bd447d1a2094"

‎page/_assets/diagonal-lines.svg

Lines changed: 1 addition & 0 deletions
Loading

‎page/_assets/favicon.ico

116 KB
Binary file not shown.

‎page/_assets/logo.svg

Lines changed: 1 addition & 0 deletions
Loading

‎page/_assets/nice_image.jpg

52.2 KB
Loading

‎page/_css/bootstrap.min.css

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎page/_css/custom.css

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
html { scroll-behavior: smooth; }
2+
header { margin: 0; padding: 0;}
3+
section { padding: 75px 0; }
4+
.jumbotron { margin-bottom: 0;}
5+
6+
/* NAVBAR */
7+
8+
#navbar-toggler-cbox:checked ~ .collapse { display:block; }
9+
.navbar-nav .active { color: #fff; }
10+
11+
.navbar-brand a { color: ghostwhite; }
12+
.navbar-brand a:hover {
13+
color: rgba(255,255,255,.5);
14+
text-decoration: none;
15+
}
16+
17+
a.nav-link.active { color: #fff !important; }
18+
19+
/* FORMATTING */
20+
21+
section h2 { margin-bottom: 1em;}
22+
23+
.lead {
24+
font-size: 20px;
25+
font-weight: 300;
26+
line-height: 30px;
27+
margin-bottom: 1em;
28+
margin-top: 0;
29+
}
30+
31+
.franklin-content ul li p { margin: 0; }
32+
33+
.katex { font-size: 1em !important;}
34+
35+
a.anchor {
36+
display: block;
37+
position: relative;
38+
top: -150px;
39+
visibility: hidden;
40+
}
41+
42+
/* CODE */
43+
44+
pre { margin-bottom: 0.5em; }
45+
pre code.hljs {
46+
padding-left: 20px;
47+
padding-top: 10px;
48+
padding-bottom: 10px;
49+
}
50+
pre code.hljs.plaintext {
51+
margin-bottom: 1em;
52+
}
53+
54+
/* ADD ANY SPECIFIC TWEAKS YOU MIGHT WANT HERE */

‎page/_layout/foot.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- CONTENT ENDS HERE -->
2+
{{ if hasmath }}
3+
{{ insert foot_katex.html }}
4+
{{ end }}
5+
{{ if hascode }}
6+
{{ insert foot_highlight.html }}
7+
{{ end }}
8+
<script src="/libs/simple-scrollspy.min.js"></script>
9+
<script>
10+
window.onload = function () {
11+
scrollSpy('#navbarResponsive', {
12+
sectionClass: '.scrollspy',
13+
menuActiveTarget: '.nav-link',
14+
offset: 100
15+
})
16+
}
17+
</script>
18+
</body>
19+
</html>

‎page/_layout/foot_highlight.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<script src="/libs/highlight/highlight.pack.js"></script>
2+
<script>hljs.initHighlightingOnLoad();hljs.configure({tabReplace: ' '});</script>

‎page/_layout/foot_katex.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<script src="/libs/katex/katex.min.js"></script>
2+
<script src="/libs/katex/auto-render.min.js"></script>
3+
<script>renderMathInElement(document.body)</script>

‎page/_layout/head.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<!-- META -->
5+
<meta charset="UTF-8">
6+
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
7+
<meta name="author" content="{{authors}}">
8+
<title>{{title}}</title>
9+
10+
<link rel="icon" type="image/png" href="/assets/favicon.ico">
11+
12+
<!-- CSS -->
13+
{{if hasmath}} {{insert head_katex.html }} {{end}}
14+
{{if hascode}} {{insert head_highlight.html }} {{end}}
15+
<link rel="stylesheet" href="/css/bootstrap.min.css">
16+
<style>{{insert style_tuning.fcss}}</style>
17+
<link rel="stylesheet" href="/css/custom.css">
18+
19+
<script async defer src="https://buttons.github.io/buttons.js"></script>
20+
</head>
21+
<body id="page-top">
22+
{{insert nav.html}}
23+
{{insert header.html}}
24+
<!-- Content appended here -->

‎page/_layout/head_highlight.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<link rel="stylesheet" href="/libs/highlight/styles/{{highlight_theme}}.css">

‎page/_layout/head_katex.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<link rel="stylesheet" href="/libs/katex/katex.min.css">

‎page/_layout/header.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<header class="text-white text-center">
2+
{{if use_hero}}
3+
<div class="jumbotron container bg-primary">
4+
{{else}}
5+
<div class="jumbotron jumbotron-fluid container-fluid bg-primary">
6+
{{end}}
7+
<h1>{{title}}</h1>
8+
<div class="lead">{{description}}</div>
9+
{{if add_github_view}}
10+
<a class="github-button" href="https://github.com/{{github_repo}}" data-size="large" aria-label="View {{title}} on GitHub">View on GitHub</a>
11+
{{end}}
12+
{{if add_github_star}}
13+
<a class="github-button" href="https://github.com/{{github_repo}}" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star {{title}} on GitHub">Star</a>
14+
{{end}}
15+
</div>
16+
</header>

‎page/_layout/nav.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<nav class="navbar navbar-expand-lg navbar-dark bg-dark fixed-top" id="mainNav">
2+
<div class="container">
3+
<span class="navbar-brand">
4+
{{if add_nav_logo}}
5+
<img src="{{nav_logo_path}}" class="img-fluid" style="{{nav_logo_style}}" alt="{{nav_logo_alt}}"/>
6+
{{end}}
7+
<a href="#page-top">{{title}}</a>
8+
{{if add_docs}}
9+
｜ <a href="{{docs_url}}" target="_blank">{{docs_name}}</a>
10+
{{end}}
11+
</span>
12+
<input type="checkbox" id="navbar-toggler-cbox" class="d-none" />
13+
<label for="navbar-toggler-cbox" class="navbar-toggler" data-toggle="collapse" data-target="#navbarResponsive" aria-controls="navbarResponsive" aria-expanded="false" aria-label="Toggle navigation">
14+
<span class="navbar-toggler-icon"></span>
15+
</label>
16+
<div class="collapse navbar-collapse" id="navbarResponsive">
17+
<ul class="navbar-nav ml-auto">
18+
{{for (s, n) in sections}}
19+
<li class="nav-item">
20+
<a class="nav-link" href="#{{fill s}}">{{fill n}}</a>
21+
</li>
22+
{{end}}
23+
</ul>
24+
</div>
25+
</div>
26+
</nav>

‎page/_layout/page_foot.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<footer class="py-5 bg-dark">
2+
<div class="container">
3+
<p class="m-0 text-center text-white">&copy; {{authors}}. Website powered by <a href="https://github.com/tlienart/Franklin.jl">Franklin.jl</a>, <a href="https://github.com/tlienart/PkgPage.jl">PkgPage.jl</a> and the <a href="https://julialang.org">Julia</a> programming language.</p>
4+
</div>
5+
</footer>

‎page/_layout/style_tuning.fcss

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
.bg-primary {
2+
background-color: {{header_color}} !important;
3+
}
4+
5+
a {
6+
color: {{link_color}};
7+
}
8+
9+
a:hover {
10+
color: {{link_hover_color}};
11+
}
12+
13+
.section-bg-color {
14+
background-color: {{section_bg_color}};
15+
}
16+
17+
footer a {
18+
color: {{footer_link_color}};
19+
}
20+
21+
{{if use_hero}}
22+
.jumbotron {
23+
width: {{hero_width}};
24+
}
25+
26+
header {
27+
margin-top: {{hero_margin_top}} !important;
28+
}
29+
{{else}}
30+
header {
31+
margin-top: {{header_margin_top}} !important;
32+
}
33+
{{end}}
34+
35+
{{if use_header_img}}
36+
.jumbotron {
37+
background-image: {{header_img_path}};
38+
background-repeat: repeat;
39+
}
40+
{{end}}
41+
42+
/* CODE ADJUSTMENTS */
43+
44+
pre code.hljs {
45+
border-radius: {{code_border_radius}};
46+
}
47+
48+
pre code.hljs.plaintext {
49+
margin-left: {{code_output_indent}};
50+
}

‎page/_layout/tag.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--
2+
IMPORTANT NOTE:
3+
on tag pages you CANNOT rely on local page variable such as `hasmath`
4+
`hascode`, `title` etc as the generation of the tag pages will be triggered
5+
by different pages each of which will have defined these variables in
6+
a different ways.
7+
For tag pages, ALL variables used MUST be
8+
- global ones (whatever you might have defined in `config`)
9+
- be tag string (`tag`)
10+
otherwise you cannot guarantee their content.
11+
There is one way to bend this: you can use {{fill varname rpath}} to
12+
input the value of the variable `varname` defined at the page corresponding
13+
to `rpath`.
14+
You can also use `{{istag hello}} ... {{end}}` to have things that
15+
depend upon which tag we're on (for instance if you want a specific title).
16+
-->
17+
<!doctype html>
18+
<html lang="en">
19+
<head>
20+
<meta charset="UTF-8">
21+
<meta name="viewport" content="width=device-width, initial-scale=1">
22+
<title>Tag: {{fill fd_tag}}</title>
23+
</head>
24+
<body>
25+
<div class="{{div_content}}">
26+
<h1>Tag: {{fill fd_tag}}</h1>
27+
{{taglist}}
28+
{{insert page_foot.html}}
29+
</div>
30+
</body>
31+
</html>

‎page/_libs/highlight/highlight.pack.js

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)