Merge remote-tracking branch 'remotes/origin/landing_page' into new_main

Makefile

@@ -0,0 +1,9 @@
+%.html: %.md template.html metadata.yml assets/css/style.css
+	pandoc "$<" --template "$<" --metadata-file=metadata.yml | pandoc --template "template.html" --metadata-file=metadata.yml -c "assets/css/style.css" --write=html5 -o "$@"
+	@sed -i 's/<\/a> | <a href/<\/a> |\n<a href/g' "$@"
+
+tutorials.md: tutorials.py tutorials_header.md build/doc/tutorials/Readme.md
+	python3 "$<"
+
+videos.md: videos.py videos_header.md build/doc/tutorials/Readme.md
+	python3 "$<"

Readme.md

@@ -0,0 +1,13 @@
+# ESPResSo documentation
+
+These GitHub Pages provide the user manuals of every ESPResSo release since
+4.0.0 as well as the user guide, tutorials and doxygen documentation of the
+development branch of ESPResSo (updated during nightly builds). When adding
+a new release, update the `latest_release` variable in file `metadata.yml`.
+
+The material is generated automatically from ESPResSo sources licensed under
+the [GNU GPL 3](https://www.gnu.org/licenses/gpl-3.0.en.html), unless stated
+otherwise. The theme files were obtained from jekyll-theme-slate, available
+at [pages-themes/slate](https://github.com/pages-themes/slate) and licensed
+under the [CC0 1.0 Universal](http://creativecommons.org/publicdomain/zero/1.0/).
+The Jekyll template was generated with Jekyll 3.9.0.

_config.yml

@@ -0,0 +1,4 @@
+title: ESPResSo
+description: Extensible Simulation Package for Research on Soft Matter Systems
+logo: https://github.com/espressomd/espresso/blob/4.2.0/doc/logo/logo_500x500.png
+theme: jekyll-theme-slate

assets/css/style.css

@@ -0,0 +1,145 @@
+.highlight table td{padding:5px}
+.highlight table pre{margin:0}
+.highlight .cm{color:#777772;font-style:italic}
+.highlight .cp{color:#797676;font-weight:bold}
+.highlight .c1{color:#777772;font-style:italic}
+.highlight .cs{color:#797676;font-weight:bold;font-style:italic}
+.highlight .c,.highlight .cd{color:#777772;font-style:italic}
+.highlight .err{color:#a61717;background-color:#e3d2d2}
+.highlight .gd{color:#000000;background-color:#ffdddd}
+.highlight .ge{color:#000000;font-style:italic}
+.highlight .gr{color:#aa0000}
+.highlight .gh{color:#797676}
+.highlight .gi{color:#000000;background-color:#ddffdd}
+.highlight .go{color:#888888}
+.highlight .gp{color:#555555}
+.highlight .gs{font-weight:bold}
+.highlight .gu{color:#aaaaaa}
+.highlight .gt{color:#aa0000}
+.highlight .kc{color:#000000;font-weight:bold}
+.highlight .kd{color:#000000;font-weight:bold}
+.highlight .kn{color:#000000;font-weight:bold}
+.highlight .kp{color:#000000;font-weight:bold}
+.highlight .kr{color:#000000;font-weight:bold}
+.highlight .kt{color:#445588;font-weight:bold}
+.highlight .k,.highlight .kv{color:#000000;font-weight:bold}
+.highlight .mf{color:#009999}
+.highlight .mh{color:#009999}
+.highlight .il{color:#009999}
+.highlight .mi{color:#009999}
+.highlight .mo{color:#009999}
+.highlight .m,.highlight .mb,.highlight .mx{color:#009999}
+.highlight .sb{color:#d14}
+.highlight .sc{color:#d14}
+.highlight .sd{color:#d14}
+.highlight .s2{color:#d14}
+.highlight .se{color:#d14}
+.highlight .sh{color:#d14}
+.highlight .si{color:#d14}
+.highlight .sx{color:#d14}
+.highlight .sr{color:#009926}
+.highlight .s1{color:#d14}
+.highlight .ss{color:#990073}
+.highlight .s{color:#d14}
+.highlight .na{color:#008080}
+.highlight .bp{color:#797676}
+.highlight .nb{color:#0086B3}
+.highlight .nc{color:#445588;font-weight:bold}
+.highlight .no{color:#008080}
+.highlight .nd{color:#3c5d5d;font-weight:bold}
+.highlight .ni{color:#800080}
+.highlight .ne{color:#990000;font-weight:bold}
+.highlight .nf{color:#990000;font-weight:bold}
+.highlight .nl{color:#990000;font-weight:bold}
+.highlight .nn{color:#555555}
+.highlight .nt{color:#000080}
+.highlight .vc{color:#008080}
+.highlight .vg{color:#008080}
+.highlight .vi{color:#008080}
+.highlight .nv{color:#008080}
+.highlight .ow{color:#000000;font-weight:bold}
+.highlight .o{color:#000000;font-weight:bold}
+.highlight .w{color:#bbbbbb}
+.highlight{background-color:#f8f8f8}
+html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td,article,aside,canvas,details,embed,figure,figcaption,footer,header,hgroup,menu,nav,output,ruby,section,summary,time,mark,audio,video{margin:0;padding:0;border:0;font:inherit;vertical-align:baseline}
+article,aside,details,figcaption,figure,footer,header,hgroup,menu,nav,section{display:block}
+ol,ul{list-style:none}
+table{border-collapse:collapse;border-spacing:0}
+body{box-sizing:border-box;color:#373737;background:#212121;font-size:16px;font-family:'Myriad Pro', Calibri, Helvetica, Arial, sans-serif;line-height:1.5;-webkit-font-smoothing:antialiased}
+h1,h2,h3,h4,h5,h6{margin:10px 0;font-weight:700;color:#222222;font-family:'Lucida Grande', 'Calibri', Helvetica, Arial, sans-serif;letter-spacing:-1px}
+h1{font-size:36px;font-weight:700}
+h2{padding-bottom:10px;font-size:32px;background:url("../../images/bg_hr.png") repeat-x bottom}
+h3{font-size:24px}
+h4{font-size:21px}
+h5{font-size:18px}
+h6{font-size:16px}
+p{margin:10px 0 15px 0}
+footer p{color:#f2f2f2}
+a{text-decoration:none;color:#0F79D0;text-shadow:none;transition:color 0.5s ease;transition:text-shadow 0.5s ease;-webkit-transition:color 0.5s ease;-webkit-transition:text-shadow 0.5s ease;-moz-transition:color 0.5s ease;-moz-transition:text-shadow 0.5s ease;-o-transition:color 0.5s ease;-o-transition:text-shadow 0.5s ease;-ms-transition:color 0.5s ease;-ms-transition:text-shadow 0.5s ease}
+a:hover,a:focus{text-decoration:underline}
+footer a{color:#F2F2F2;text-decoration:underline}
+em,cite{font-style:italic}
+strong{font-weight:bold}
+img{position:relative;margin:0 auto;max-width:739px;padding:5px;margin:10px 0 10px 0;border:1px solid #ebebeb;box-shadow:0 0 5px #ebebeb;-webkit-box-shadow:0 0 5px #ebebeb;-moz-box-shadow:0 0 5px #ebebeb;-o-box-shadow:0 0 5px #ebebeb;-ms-box-shadow:0 0 5px #ebebeb}
+p img{display:inline;margin:0;padding:0;vertical-align:middle;text-align:center;border:none}
+pre,code{color:#222;background-color:#fff;font-family:Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace;font-size:14px;border-radius:2px;-moz-border-radius:2px;-webkit-border-radius:2px}
+pre{padding:10px;box-shadow:0 0 10px rgba(0,0,0,0.1);overflow:auto}
+code{padding:3px;margin:0 3px;box-shadow:0 0 10px rgba(0,0,0,0.1)}
+pre code{display:block;box-shadow:none}
+blockquote{color:#666;margin-bottom:20px;padding:0 0 0 20px;border-left:3px solid #bbb}
+ul,ol,dl{margin-bottom:15px}
+ul{list-style-position:inside;list-style:disc;padding-left:20px}
+ol{list-style-position:inside;list-style:decimal;padding-left:20px}
+dl dt{font-weight:bold}
+dl dd{padding-left:20px;font-style:italic}
+dl p{padding-left:20px;font-style:italic}
+hr{height:1px;margin-bottom:5px;border:none;background:url("../../images/bg_hr.png") repeat-x center}
+table{border:1px solid #373737;margin-bottom:20px;text-align:left}
+th{font-family:'Lucida Grande', 'Helvetica Neue', Helvetica, Arial, sans-serif;padding:10px;background:#373737;color:#fff}
+td{padding:10px;border:1px solid #373737}
+form{background:#f2f2f2;padding:20px}
+.outer{width:100%}
+.inner{position:relative;max-width:640px;padding:20px 10px;margin:0 auto}
+#forkme_banner{display:block;position:absolute;top:0;right:10px;z-index:10;padding:10px 50px 10px 10px;color:#fff;background:url("../../images/blacktocat.png") #0090ff no-repeat 95% 50%;font-weight:700;box-shadow:0 0 10px rgba(0,0,0,0.5);border-bottom-left-radius:2px;border-bottom-right-radius:2px}
+#header_wrap{background:#212121;background:-moz-linear-gradient(top, #373737, #212121);background:-webkit-linear-gradient(top, #373737, #212121);background:-ms-linear-gradient(top, #373737, #212121);background:-o-linear-gradient(top, #373737, #212121);background:linear-gradient(to top, #373737, #212121)}
+#header_wrap .inner{padding:50px 10px 30px 10px}
+#project_title{margin:0;color:#fff;font-size:42px;font-weight:700;text-shadow:#111 0px 0px 10px}
+#project_tagline{color:#fff;font-size:24px;font-weight:300;background:none;text-shadow:#111 0px 0px 10px}
+#downloads{position:absolute;width:120px;z-index:10;bottom:-40px;right:0;height:70px;background:url("../../images/icon_download.png") no-repeat 0% 90%}
+.zip_download_link{display:block;float:right;width:90px;height:70px;text-indent:-5000px;overflow:hidden;background:url(../../images/sprite_download.png) no-repeat bottom left}
+.tar_download_link{display:block;float:right;width:90px;height:70px;text-indent:-5000px;overflow:hidden;background:url(../../images/sprite_download.png) no-repeat bottom right;margin-left:10px}
+.zip_download_link:hover{background:url(../../images/sprite_download.png) no-repeat top left}
+.tar_download_link:hover{background:url(../../images/sprite_download.png) no-repeat top right}
+#main_content_wrap{background:#f2f2f2;border-top:1px solid #111;border-bottom:1px solid #111}
+#main_content{padding-top:40px}
+#footer_wrap{background:#212121}
+@media screen and (max-width: 992px){
+img{max-width:100%}
+}
+@media screen and (max-width: 480px){
+body{font-size:14px}
+#downloads{display:none}
+.inner{min-width:320px;max-width:480px}
+#project_title{font-size:32px}
+h1{font-size:28px}
+h2{font-size:24px}
+h3{font-size:21px}
+h4{font-size:18px}
+h5{font-size:14px}
+h6{font-size:12px}
+code,pre{font-size:11px}
+}
+@media screen and (max-width: 320px){
+body{font-size:14px}
+#downloads{display:none}
+.inner{min-width:240px;max-width:320px}
+#project_title{font-size:28px}
+h1{font-size:24px}
+h2{font-size:21px}
+h3{font-size:18px}
+h4{font-size:16px}
+h5{font-size:14px}
+h6{font-size:12px}
+code,pre{min-width:240px;max-width:320px;font-size:11px}
+}
+

index.md

@@ -0,0 +1,28 @@
+# User guide
+
+* For [ESPResSo devel](doc/index.html)
+$if(latest_release)$
+* For [ESPResSo $latest_release$](doc$latest_release$/index.html)
+$endif$
+
+# Tutorials
+
+* For [ESPResSo devel](tutorials.html)
+$if(latest_release)$
+* For [ESPResSo $latest_release$](tutorials$latest_release$.html)
+$endif$
+* [Online videos](videos.html)
+
+# Development
+
+* [Developer's Guide](https://github.com/espressomd/espresso/wiki)
+* [Doxygen documentation](dox/index.html)
+
+# Further documentation
+
+* [Quickstart](quickstart.html)
+* [Installation FAQ](https://github.com/espressomd/espresso/wiki/Installation-FAQ)
+* [Filing bug reports](https://github.com/espressomd/espresso/wiki/Filing-bug-reports)
+* [User's Mailing List](http://espressomd.org/wordpress/?page_id=79)
+  ([archives](http://lists.nongnu.org/archive/html/espressomd-users/))
+* [ESPResSo official website](http://espressomd.org/wordpress/)

metadata.yml

@@ -0,0 +1,6 @@
+title: "ESPResSo"
+title-prefix: "ESPResSo documentation"
+lang: "en_US"
+subtitle: "Extensible Simulation Package for Research on Soft Matter Systems"
+latest_release: 4.2.1
+layout: default

quickstart.md

@@ -0,0 +1,8 @@
+# Quickstart
+
+New users should follow these steps to get **ESPResSo** running:
+
+1. Check the [installation requirements](doc/installation.html#requirements) for your operating system
+2. [Download **ESPResSo**](https://espressomd.org/wordpress/download/)
+3. [Build **ESPResSo**](doc/installation.html#quick-installation)
+4. Run your script with `./pypresso my_script.py`

template.html

@@ -0,0 +1,94 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="$lang$" xml:lang="$lang$"$if(dir)$ dir="$dir$"$endif$>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+  <meta charset="utf-8" />
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width,maximum-scale=2">
+  <meta name="generator" content="pandoc" />
+$for(author-meta)$
+  <meta name="author" content="$author-meta$" />
+$endfor$
+$if(date-meta)$
+  <meta name="dcterms.date" content="$date-meta$" />
+$endif$
+$if(keywords)$
+  <meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$" />
+$endif$
+  <style type="text/css">
+$if(quotes)$
+      q { quotes: "“" "”" "‘" "’"; }
+$endif$
+  </style>
+$for(css)$
+  <link rel="stylesheet" href="$css$" />
+$endfor$
+$if(math)$
+  $math$
+$endif$
+$for(header-includes)$
+  $header-includes$
+$endfor$
+
+<!-- Begin Jekyll SEO tag v2.7.1 -->
+<title>$if(title-prefix)$$title-prefix$ | $endif$$pagetitle$</title>
+<meta name="generator" content="Jekyll v3.9.0">
+<meta property="og:title" content="$if(title-prefix)$$title-prefix$ | $endif$$pagetitle$">
+<meta property="og:locale" content="$lang$">
+<meta name="description" content="$subtitle$">
+<meta property="og:description" content="$subtitle$">
+<link rel="canonical" href="https://espressomd.github.io">
+<meta property="og:url" content="https://espressomd.github.io">
+<meta property="og:site_name" content="ESPResSo">
+<script type="application/ld+json">
+{"description":"$subtitle$","url":"https://espressomd.github.io","@type":"WebSite","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://github.com/espressomd/espresso/blob/python/doc/logo/logo_500x500.png"}},"headline":"$title-prefix$","name":"$pagetitle$","@context":"https://schema.org"}</script>
+<!-- End Jekyll SEO tag -->
+</head>
+<body>
+$for(include-before)$
+$include-before$
+$endfor$
+
+
+    <!-- HEADER -->
+    <div id="header_wrap" class="outer">
+        <header class="inner">
+          <a id="forkme_banner" href="https://github.com/espressomd/espresso">View on GitHub</a>
+
+          <h1 id="project_title">ESPResSo</h1>
+          <h2 id="project_tagline">Extensible Simulation Package for Research on Soft Matter Systems</h2>
+
+$if(latest_release)$
+            <section id="downloads">
+              <a class="tar_download_link" href="https://github.com/espressomd/espresso/releases/download/$latest_release$/espresso-$latest_release$.tar.gz">Download this project as a tar.gz file</a>
+            </section>
+$endif$
+
+        </header>
+    </div>
+
+    <!-- MAIN CONTENT -->
+    <div id="main_content_wrap" class="outer">
+      <section id="main_content" class="inner">
+
+$body$
+
+      </section>
+    </div>
+
+    <!-- FOOTER  -->
+    <div id="footer_wrap" class="outer">
+      <footer class="inner">
+
+        <p class="copyright">ESPResSo maintained by <a href="https://github.com/espressomd">espressomd</a></p>
+
+        <p>Published with <a href="https://pages.github.com/">GitHub Pages</a></p>
+      </footer>
+    </div>
+
+
+$for(include-after)$
+$include-after$
+$endfor$
+</body>
+</html>

tutorials.py

@@ -0,0 +1,41 @@
+#
+# Copyright (C) 2021 The ESPResSo project
+#
+# This file is part of ESPResSo.
+#
+# ESPResSo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ESPResSo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+"""
+This script generates the landing page for tutorials.
+"""
+
+import re
+
+marker_begin = '[comment]: # (Begin of tutorials landing page)'
+marker_end = '[comment]: # (End of tutorials landing page)'
+
+with open('build/doc/tutorials/Readme.md') as f:
+    content = f.read()
+
+assert marker_begin in content, f'Readme.md is missing "{marker_begin}"'
+assert marker_end in content, f'Readme.md is missing "{marker_end}"'
+tutorial_descriptions = content.split(marker_begin)[1].split(marker_end)[0]
+tutorial_descriptions = tutorial_descriptions.replace('.ipynb', '.html')
+tutorial_descriptions = re.sub(r"\]\((?!https?://)", '](tutorials/', tutorial_descriptions)
+
+with open('tutorials_header.md', 'r') as f:
+    tutorial_header = f.read()
+
+with open('tutorials.md', 'w') as f:
+    f.write(tutorial_header + tutorial_descriptions)

tutorials_header.md

@@ -0,0 +1,4 @@
+# Tutorials
+
+All tutorials are available as Jupyter notebooks and can be found in `doc/tutorials/` in the
+source code and [on GitHub](https://github.com/espressomd/espresso/tree/python/doc/tutorials).

videos.py

@@ -0,0 +1,37 @@
+#
+# Copyright (C) 2021 The ESPResSo project
+#
+# This file is part of ESPResSo.
+#
+# ESPResSo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ESPResSo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+"""
+This script generates the landing page for video lectures.
+"""
+
+marker_begin = '[comment]: # (Begin of videos landing page)'
+marker_end = '[comment]: # (End of videos landing page)'
+
+with open('build/doc/tutorials/Readme.md') as f:
+    content = f.read()
+
+assert marker_begin in content, f'Readme.md is missing "{marker_begin}"'
+assert marker_end in content, f'Readme.md is missing "{marker_end}"'
+video_descriptions = content.split(marker_begin)[1].split(marker_end)[0]
+
+with open('videos_header.md', 'r') as f:
+    video_header = f.read()
+
+with open('videos.md', 'w') as f:
+    f.write(video_header + video_descriptions)