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

Reworked installation page and added buttons in css #31

Merged
merged 6 commits into from
Mar 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
83 changes: 83 additions & 0 deletions docs/css/buttons.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
a.xournalppButton {
Technius marked this conversation as resolved.
Show resolved Hide resolved
display: inline-flex;
position: relative;
justify-content: center;
align-items: center;
flex-shrink: 0;
background-color: var(--md-primary-fg-color);
color: var(--md-primary-bg-color);
padding: 7px;
cursor: pointer;
font-size: 20px;
width: 100%;
height: 100%;
border-radius: 3px;
}

a.xournalppButton:hover {
color: var(--md-primary-bg-color--light);
}

a.linkButton, a.downloadButton {
padding-left: 35px;
}

a.linkButton:before {
display: block;
position: absolute;
left: 5px;
content: "";
width: 24px;
height: 24px;
background: url(/icons/octicons/link-external.svg);
background-size: cover;
background-repeat: no-repeat;
}

a.downloadButton:before {
display: block;
position: absolute;
left: 5px;
content: "";
width: 24px;
height: 24px;
background: url(/icons/octicons/desktop-download.svg);
background-size: cover;
margin-right: 10px;
background-repeat: no-repeat;
}

.flexedButtonsContainer {
display: flex;
justify-content: left;
}

.flexedButtonsContainer > li {
margin-right: 10px;
list-style-type: none;
}

.downloadsContainer {
display: grid;
justify-content: center;
text-align: center;
margin-top: 20px;
grid-gap: 8px;
}

.downloadsContainer > li {
list-style-type: none;
margin: 0 !important;
}

#osContainer > a {
font-size: 24px;
}

#osContainer, #macosDownloadsContainer, #windowsDownloadsContainer {
grid-template-columns: repeat(auto-fill, minmax(300px, 1fr));
}

#linuxDownloadsContainer, #debianContainer, #ubuntuContainer {
grid-template-columns: repeat(auto-fill, minmax(300px, 1fr));
}
21 changes: 21 additions & 0 deletions docs/icons/octicons/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
1 change: 1 addition & 0 deletions docs/icons/octicons/desktop-download.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/icons/octicons/link-external.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 10 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Xournal++

<div class="flexedButtonsContainer">
<li><a class="xournalppButton downloadButton" style="margin: 8px;" href="installation">Download</a></li>
<li><a class="xournalppButton linkButton" style="margin: 8px;" href="https://github.com/xournalpp/xournalpp/">Github Page</a></li>
<li><a class="xournalppButton linkButton" style="margin: 8px;" href="https://gitlab.com/TheOneWithTheBraid/xournalpp_mobile">Xournal++ mobile</a></li>
<!-- TODO: Add some more quick buttons -->
</div>

## General info

**Note: this website is new and a work-in-progress. In the meantime, please
use the [GitHub page](https://github.com/xournalpp/xournalpp) for more
information.**
Expand All @@ -9,7 +18,7 @@ target of flexibility, functionality, and speed. It is a modern rewrite and more
feature-rich version of the wonderful
[Xournal](http://sourceforge.net/projects/xournal/) program.

To install Xournal++, please follow the instructions on the [installation
To install Xournal++, please follow to the [installation
page](installation).

## Some highlighted features
Expand Down
81 changes: 0 additions & 81 deletions docs/installation.md

This file was deleted.

11 changes: 11 additions & 0 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Please choose your OS

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).

<ul id="osContainer" class="downloadsContainer">
<li><a class="xournalppButton" href="windows">Windows</a></li>
<li><a class="xournalppButton" href="macos">MacOS</a></li>
<li><a class="xournalppButton" href="linux">Linux</a></li>
</ul>


83 changes: 83 additions & 0 deletions docs/installation/linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Linux installation

## General information

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.

## Options for all/most distros

The following options are available on most major Linux distros.

<ul id="linuxDownloadsContainer" class="downloadsContainer">
<li><a class="xournalppButton downloadButton" href="{{downloads.linux.appimage}}">AppImage</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.linux.flatpak}}">FlatPak</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.linux.snap}}">Snap Package</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.allVersions}}">Other versions</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.nightly}}">Nightly (latest unstable, including nightly AppImage)</a></li>
<li><a class="xournalppButton linkButton" href="#options-for-specific-distros-potentially-preferable">Or use distro specific method</a></li>
</ul>

## Options for specific distros (potentially preferable)

On _specific Linux distros_ you have the following extra options:

### Ubuntu and derivatives

* Install the latest *unstable* nightly release from the following ppa

sudo add-apt-repository ppa:andreasbutti/xournalpp-master
sudo apt update
sudo apt install xournalpp

which you can easily upgrade via `sudo apt update && sudo apt upgrade`

* Install the latest *stable* release from the following *unofficial* ppa

sudo add-apt-repository ppa:apandada1/xournalpp-stable
sudo apt update
sudo apt install xournalpp

* Or:
<ul id="ubuntuContainer" class="downloadsContainer">
<li><a class="xournalppButton linkButton" href="{{downloads.linux.ubuntuStable}}">Download stable</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.nightly}}">Download nightly (latest unstable) version</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.allVersions}}">Other versions</a></li>
</ul>

### Debian Buster

<ul id="debianContainer" class="downloadsContainer">
<li><a class="xournalppButton linkButton" href="{{downloads.linux.debianStable}}">Download stable</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.nightly}}">Download nightly (latest unstable) version</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.allVersions}}">Other versions</a></li>
</ul>

### Fedora

Install the latest stable release via

dnf install xournalpp

### openSuse

Install the latest stable release via

zypper in xournalpp

### Solus

Install the latest stable release via

sudo eopkg it xournalpp

### Arch

Install the latest stable release from the _community_ repository via

pacman -S xournalpp

### NixOS/Nix

Install the latest stable release via

nix-env -iA nixpkgs.xournalpp
21 changes: 21 additions & 0 deletions docs/installation/macos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# MacOS installation

## General information

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.

## Downloading the program

<ul id="macosDownloadsContainer" class="downloadsContainer">
<li><a class="xournalppButton downloadButton" href="{{downloads.macos.stable}}">Stable (Recommended)</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.nightly}}">Nightly (latest unstable)</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.allVersions}}">Other versions</a></li>
</ul>

In case of downloading a different version than the stable one, remember to download the `macos` version.

## Installing program

> After installation, it would be nice if you could improve this guide

Just download the archive and run the unzipped executable.
25 changes: 25 additions & 0 deletions docs/installation/windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Windows installation

## General information

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.

## Downloading the program

<ul id="windowsDownloadsContainer" class="downloadsContainer">
<li><a class="xournalppButton downloadButton" href="{{downloads.windows.stable}}">Stable (Recommended)</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.nightly}}">Nightly (latest unstable)</a></li>
<li><a class="xournalppButton linkButton" href="{{downloads.allVersions}}">Other versions</a></li>
</ul>

In case of downloading a different version than the stable one, remember to download the `windows` version.

## Installing the program

Installing Xournalpp is really easy:

1. Unzip archive which should be named something like `xournalpp-{version}-windows.zip`.
2. Run the installation executable (`xournalpp-{version}-windows.exe`).
3. Follow the installation steps.
4. Success !

Loading