Skip to content

Commit c077d03

Browse files
TechniusTechnius
authored
Merge pull request #51 from Fatih20/Installation-page-redesign
Complete Redesign of the Installation Page
2 parents ff00ed8 + a1233ba commit c077d03

18 files changed

+979
-162
lines changed

‎docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
template: home.html
2+
template: home/home.html
33
title: Xournal++
44
---
55
{newline}

‎docs/installation/index.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
# Please choose your OS
2-
3-
Xournal++ is a free and open source program and is available on most of the desktop OSes. Please choose the operating system that you are using and follow the appropriate guide. If you are having trouble with your guide, you may want to visit the [Github page](https://github.com/xournalpp/xournalpp#Installing) or [report an issue](https://github.com/xournalpp/xournalpp.github.io/issues).
4-
5-
<ul id="osContainer" class="downloadsContainer">
6-
<li><a class="xournalppButton" href="windows">Windows</a></li>
7-
<li><a class="xournalppButton" href="macos">MacOS</a></li>
8-
<li><a class="xournalppButton" href="linux">Linux</a></li>
9-
</ul>
10-
11-
1+
---
2+
template: installation/installation.html
3+
title: Installation
4+
hide:
5+
- navigation
6+
- toc
7+
---
8+
9+
{{newline}}

‎docs/installation/linux.md

Lines changed: 9 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,9 @@
1-
# Linux installation
2-
3-
## General information
4-
5-
Xournal++ is a free and open source program and can be easily compiled from source, although for user convenience it is also distributed via precompiled binary. In case you want to compile xournalpp on your own you should follow the guide on the [github page](https://github.com/xournalpp/xournalpp/blob/master/readme/LinuxBuild.md). If you decide to do otherwise, then this guide is dedicated to that process.
6-
7-
## Options for all/most distros
8-
9-
The following options are available on most major Linux distros.
10-
11-
<ul id="linuxDownloadsContainer" class="downloadsContainer">
12-
<li><a class="xournalppButton downloadButton" href="{{downloads.linux.appimage}}">AppImage</a></li>
13-
<li><a class="xournalppButton linkButton" href="{{downloads.linux.flatpak}}">FlatPak</a></li>
14-
<li><a class="xournalppButton linkButton" href="{{downloads.linux.snap}}">Snap Package</a></li>
15-
<li><a class="xournalppButton linkButton" href="{{downloads.allVersions}}">Other versions</a></li>
16-
<li><a class="xournalppButton linkButton" href="{{downloads.nightly}}">Nightly (latest unstable, including nightly AppImage)</a></li>
17-
<li><a class="xournalppButton linkButton" href="#options-for-specific-distros-potentially-preferable">Or use distro specific method</a></li>
18-
</ul>
19-
20-
## Options for specific distros (potentially preferable)
21-
22-
On _specific Linux distros_ you have the following extra options:
23-
24-
### Ubuntu and derivatives
25-
26-
* Install the latest *unstable* nightly release from the following ppa
27-
28-
sudo add-apt-repository ppa:andreasbutti/xournalpp-master
29-
sudo apt update
30-
sudo apt install xournalpp
31-
32-
which you can easily upgrade via `sudo apt update && sudo apt upgrade`
33-
34-
* Install the latest *stable* release from the following *unofficial* ppa
35-
36-
sudo add-apt-repository ppa:apandada1/xournalpp-stable
37-
sudo apt update
38-
sudo apt install xournalpp
39-
40-
* Or:
41-
<ul id="ubuntuContainer" class="downloadsContainer">
42-
<li><a class="xournalppButton linkButton" href="{{downloads.linux.ubuntuStable}}">Download stable</a></li>
43-
<li><a class="xournalppButton linkButton" href="{{downloads.nightly}}">Download nightly (latest unstable) version</a></li>
44-
<li><a class="xournalppButton linkButton" href="{{downloads.allVersions}}">Other versions</a></li>
45-
</ul>
46-
47-
### Debian Buster
48-
49-
<ul id="debianContainer" class="downloadsContainer">
50-
<li><a class="xournalppButton linkButton" href="{{downloads.linux.debianStable}}">Download stable</a></li>
51-
<li><a class="xournalppButton linkButton" href="{{downloads.nightly}}">Download nightly (latest unstable) version</a></li>
52-
<li><a class="xournalppButton linkButton" href="{{downloads.allVersions}}">Other versions</a></li>
53-
</ul>
54-
55-
### Fedora
56-
57-
Install the latest stable release via
58-
59-
dnf install xournalpp
60-
61-
### openSuse
62-
63-
Install the latest stable release via
64-
65-
zypper in xournalpp
66-
67-
### Solus
68-
69-
Install the latest stable release via
70-
71-
sudo eopkg it xournalpp
72-
73-
### Arch
74-
75-
Install the latest stable release from the _community_ repository via
76-
77-
pacman -S xournalpp
78-
79-
### NixOS/Nix
80-
81-
Install the latest stable release via
82-
83-
nix-env -iA nixpkgs.xournalpp
1+
---
2+
template: installation/linux.html
3+
title: Linux Installation
4+
hide:
5+
- navigation
6+
- toc
7+
---
8+
9+
{{newline}}

‎docs/installation/macos.md

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
1-
# MacOS installation
2-
3-
## General information
4-
5-
Xournal++ is a free and open source program and can be easily compiled from source, although for user convenience it is also distributed via precompiled binary. In case you want to compile xournalpp on your own you should follow the guide on the [github page](https://github.com/xournalpp/xournalpp/blob/master/readme/MacBuild.md). If you decide to do otherwise, then this guide is dedicated to that process.
6-
7-
## Downloading the program
8-
9-
<ul id="macosDownloadsContainer" class="downloadsContainer">
10-
<li><a class="xournalppButton downloadButton" href="{{downloads.macos.stable}}">Stable (Recommended)</a></li>
11-
<li><a class="xournalppButton linkButton" href="{{downloads.nightly}}">Nightly (latest unstable)</a></li>
12-
<li><a class="xournalppButton linkButton" href="{{downloads.allVersions}}">Other versions</a></li>
13-
</ul>
14-
15-
In case of downloading a different version than the stable one, remember to download the `macos` version.
16-
17-
## Installing program
18-
19-
> After installation, it would be nice if you could improve this guide
20-
21-
Just download the archive and run the unzipped executable.
1+
---
2+
template: installation/macos.html
3+
title: MacOS Installation
4+
hide:
5+
- navigation
6+
- toc
7+
---
8+
9+
{{newline}}

‎docs/installation/windows.md

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,9 @@
1-
# Windows installation
2-
3-
## General information
4-
5-
Xournal++ is a free and open source program and can be easily compiled from source, although for user convenience it is also distributed via precompiled binary (in .exe form). In case you want to compile xournalpp on your own you should follow the guide on the [github page](https://github.com/xournalpp/xournalpp/blob/master/readme/WindowsBuild.md). If you decide to do otherwise, then this guide is dedicated to that process.
6-
7-
## Downloading the program
8-
9-
<ul id="windowsDownloadsContainer" class="downloadsContainer">
10-
<li><a class="xournalppButton downloadButton" href="{{downloads.windows.stable}}">Stable (Recommended)</a></li>
11-
<li><a class="xournalppButton linkButton" href="{{downloads.nightly}}">Nightly (latest unstable)</a></li>
12-
<li><a class="xournalppButton linkButton" href="{{downloads.allVersions}}">Other versions</a></li>
13-
</ul>
14-
15-
In case of downloading a different version than the stable one, remember to download the `windows` version.
16-
17-
## Installing the program
18-
19-
Installing Xournalpp is really easy:
20-
21-
1. Unzip archive which should be named something like `xournalpp-{version}-windows.zip`.
22-
2. Run the installation executable (`xournalpp-{version}-windows.exe`).
23-
3. Follow the installation steps.
24-
4. Success !
25-
1+
---
2+
template: installation/windows.html
3+
title: Windows Installation
4+
hide:
5+
- navigation
6+
- toc
7+
---
8+
9+
{{newline}}

‎mkdocs.yml

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ nav:
3131
#Theme config
3232
theme:
3333
name: material
34-
custom_dir: docs/overrides
34+
custom_dir: overrides
3535
favicon: img/favicon.ico
3636
logo: img/favicon.ico
3737
icon:
@@ -51,23 +51,9 @@ extra_css:
5151
#Enable macros
5252
plugins:
5353
- search
54-
- macros
54+
- macros
5555

5656
extra:
57-
downloads:
58-
default: "https://github.com/xournalpp/xournalpp/releases"
59-
allVersions: "https://github.com/xournalpp/xournalpp/tags"
60-
nightly: "https://github.com/xournalpp/xournalpp/releases/tag/nightly"
61-
windows:
62-
stable: "https://github.com/xournalpp/xournalpp/releases/download/1.1.0/xournalpp-1.1.0-windows.zip"
63-
macos:
64-
stable: "https://github.com/xournalpp/xournalpp/releases/download/1.1.0/xournalpp-1.1.0-macos.zip"
65-
linux:
66-
flatpak: "https://flathub.org/apps/details/com.github.xournalpp.xournalpp"
67-
appimage: "https://github.com/xournalpp/xournalpp/releases/download/1.1.0/xournalpp-1.1.0-x86_64.AppImage"
68-
snap: "https://snapcraft.io/xournalpp"
69-
debianStable: "https://github.com/xournalpp/xournalpp/releases/tag/1.1.0"
70-
ubuntuStable: "https://github.com/xournalpp/xournalpp/releases/tag/1.1.0"
7157
version:
7258
latest_stable: "1.1.0"
7359
latest_unstable: "1.1.0+dev"
@@ -76,5 +62,6 @@ extra:
7662
markdown_extensions:
7763
- pymdownx.highlight
7864
- pymdownx.superfences
65+
- pymdownx.tabbed
7966
- toc:
8067
permalink: true

‎overrides/home/feature-showcase-content.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
{% set feature_list =
2+
[
3+
({
4+
"title": "Handwrite your notes",
5+
"description_list":
6+
[
7+
"Support for pressure-sensitive stylus and drawing tablets (Wacom, Huion, XP-Pen, etc.)",
8+
"Robust and customizable pen, highlighter and eraser tools, allowing you to write how you want to write"
9+
],
10+
"documentation_link": "#",
11+
"demonstration_video_link": "#",
12+
"image_filename": "Handwritten.png"
13+
}),
14+
15+
({
16+
"title": "Keep your work organized",
17+
"description_list":
18+
[
19+
"Use layers to make complex notes that are still pleasant to work with",
20+
"Keep track of the notes by using page previews"
21+
],
22+
"documentation_link": "#",
23+
"demonstration_video_link": "#",
24+
"image_filename": "Layers.gif"
25+
}),
26+
27+
({
28+
"title": "Enhance and accelerate your note-taking",
29+
"description_list":
30+
[
31+
"Add images and create various shapes, from circles to splines to axis",
32+
"Snap objects to rectangular grid or degrees of rotation"
33+
],
34+
"documentation_link": "#",
35+
"demonstration_video_link": "#",
36+
"image_filename": "Create Shape.png"
37+
}),
38+
39+
({
40+
"title": "Get scientific",
41+
"description_list":
42+
[
43+
"Create anything from differential equations to electrical circuits or the structural formula of molecules using our built-in LaTeX editor"
44+
],
45+
"documentation_link": "#",
46+
"demonstration_video_link": "#",
47+
"image_filename": "Latex.png"
48+
}),
49+
50+
({
51+
"title": "Your notes, your way",
52+
"description_list":
53+
[
54+
"Customize your toolbar to create a new layout, tailor-made for you",
55+
"Use a plugin or create your own via the Lua programming language"
56+
57+
],
58+
"documentation_link": "#",
59+
"demonstration_video_link": "#",
60+
"image_filename": "Customize Toolbars.png"
61+
}),
62+
63+
({
64+
"title": "Explain every stroke",
65+
"description_list":
66+
[
67+
"Record audio while you write and insert the recording to any object in your note",
68+
"Listen to the recorded audio with the 'play object' tool"
69+
70+
],
71+
"documentation_link": "#",
72+
"demonstration_video_link": "#",
73+
"image_filename": "Audio Note.png"
74+
}),
75+
]
76+
%}
77+
78+
{% macro feature_showcase(feature_showcase_properties, chirality) -%}
79+
<div class="feature feature-{{chirality}}">
80+
<div class="feature-text">
81+
<h2>{{ feature_showcase_properties["title"] }}</h2>
82+
<div class="feature-description-container">
83+
{% for description in feature_showcase_properties["description_list"] %}
84+
<div class="feature-description">
85+
<p class="bullet-point">|</p><p>{{description}}</p>
86+
</div>
87+
{% endfor %}
88+
</div>
89+
<div class="feature-link">
90+
<a href= {{ feature_showcase_properties['documentation_link'] }} class="documentation-link">Learn more</a>
91+
<a href= {{ feature_showcase_properties['demonstration_video_link'] }} class="video-link">Watch demonstration video</a>
92+
</div>
93+
</div>
94+
<img src= "/img/{{ feature_showcase_properties['image_filename'] }}">
95+
</div>
96+
{%- endmacro %}
97+
98+
{% for feature_showcase_properties in feature_list %}
99+
{% if loop.index%2 == 0 %}
100+
{{ feature_showcase(feature_showcase_properties, "left") }}
101+
{% else %}
102+
{{ feature_showcase(feature_showcase_properties, "right") }}
103+
{% endif %}
104+
{% endfor %}
105+

‎docs/overrides/home.css renamed to ‎overrides/home/home.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
}
4848

4949
.title {
50-
margin-bottom: 40px;
50+
margin-bottom: 30px;
5151
}
5252

5353
.title h1 {
@@ -64,7 +64,7 @@
6464
.Xournal p {
6565
font-weight: medium;
6666
font-size: 24px;
67-
margin-bottom: 20px;
67+
margin-bottom: 50px;
6868
}
6969

7070
.Xournal .Xournal-link {

‎docs/overrides/home.html renamed to ‎overrides/home/home.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
{% block tabs %}
33
{{ super() }}
44

5+
{% block extrahead %}
56
<link rel="preconnect" href="https://fonts.googleapis.com">
67
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
78
<link href="https://fonts.googleapis.com/css2?family=Montserrat:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap" rel="stylesheet">
8-
<link rel="stylesheet" href="home.css">
9-
<link rel="stylesheet" href="home_responsive.css">
9+
<link rel="stylesheet" href="{{base_url}}/home/home.css">
10+
<link rel="stylesheet" href="{{base_url}}/home/home_responsive.css">
11+
{% endblock %}
1012
<meta name="viewport" content="initial-scale=1, maximum-scale=1, width=device-width">
1113

1214
<style>
@@ -27,7 +29,7 @@ <h2>Available on MacOS, Windows, and Linux</h2>
2729
</div>
2830

2931
<div class="feature-list">
30-
{% include 'feature-showcase-content.md' %}
32+
{% include 'home/feature-showcase-content.md' %}
3133
</div>
3234
<div class="download-hyperlink bottom-button">
3335
<a href="{{ 'installation/' | url }}">Get it now</a>

‎docs/overrides/home_responsive.css renamed to ‎overrides/home/home_responsive.css

File renamed without changes.

0 commit comments

Comments
 (0)