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 1 commit
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
49 changes: 49 additions & 0 deletions docs/css/buttons.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
a.xournalppButton {
Technius marked this conversation as resolved.
Show resolved Hide resolved
background-color: var(--md-primary-fg-color);
color: var(--md-primary-bg-color);
padding: 10px;
cursor: pointer;
margin: 8px;
Mazurel marked this conversation as resolved.
Show resolved Hide resolved
font-size: 20px;
}

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

a.bigXournalppButton {
Mazurel marked this conversation as resolved.
Show resolved Hide resolved
background-color: var(--md-primary-fg-color);
color: var(--md-primary-bg-color);
padding: 10px;
cursor: pointer;
margin: 8px;
font-size: 24px;
}

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

#osContainer {
Mazurel marked this conversation as resolved.
Show resolved Hide resolved
display: grid;
justify-content: center;
grid-template-columns: repeat(3, 1fr);
text-align: center;
margin-top: 20px;
}

#macosDownloadsContainer, #windowsDownloadsContainer {
display: grid;
justify-content: center;
grid-template-columns: repeat(3, 1fr);
text-align: center;
margin-top: 20px;
}

#linuxDownloadsContainer {
display: grid;
justify-content: center;
grid-template-columns: repeat(4, 1fr);
text-align: center;
margin-top: 20px;
}
13 changes: 11 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Xournal++

<div style="display: flex; justify-content: left;">
<a class="xournalppButton" href="installation/general">Download</a>
<a class="xournalppButton" href="https://github.com/xournalpp/xournalpp/">Github Page</a>
<a class="xournalppButton" href="https://github.com/xournalpp/xournalpp/">Xournalpp mobile</a>
Mazurel marked this conversation as resolved.
Show resolved Hide resolved
<!-- 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,8 +18,8 @@ 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
page](installation).
To install Xournal++, please follow to the [installation
page](installation/general).
Mazurel marked this conversation as resolved.
Show resolved Hide resolved

## 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/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Please choose your OS

Xournalpp is a free and open source program and is avaible on most of the desktop OSes. Please choose operating system that you are using and follow the appropiate 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).
Mazurel marked this conversation as resolved.
Show resolved Hide resolved

<div id="osContainer">
<a class="bigXournalppButton" href="../windows">Windows</a>
<a class="bigXournalppButton" href="../macos">MacOS</a>
<a class="bigXournalppButton" href="../linux">Linux</a>
</div>


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

## General information

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

<div id="linuxDownloadsContainer">
<a class="xournalppButton" href="{{downloads.linux.flatpak}}">FlatPak</a>
<a class="xournalppButton" href="{{downloads.linux.appimage}}">AppImage</a>
<a class="xournalppButton" href="{{downloads.linux.snap}}">Snap Package</a>
<a class="xournalppButton" href="{{downloads.default}}">Other versions</a>
Mazurel marked this conversation as resolved.
Show resolved Hide resolved
<a class="xournalppButton" style="grid-column: 2 / 4;" href="#options-for-specific-distros-potentially-preferable">Or use distro specific method</a>
</div>

## 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

* Install the latest stable release (currently version {{ version.latest_stable }}) from the [releases page](https://github.com/xournalpp/xournalpp/releases)
* Install the latest unstable release (automated nightly build) from the [releases page](https://github.com/xournalpp/xournalpp/releases/tag/nightly)

### Debian Buster

* Install the latest stable release (version {{ version.latest_stable }}) from the [releases page](https://github.com/xournalpp/xournalpp/releases/tag/1.0.18)
Mazurel marked this conversation as resolved.
Show resolved Hide resolved
* Install the latest unstable release (automated nightly build) from the [releases page](https://github.com/xournalpp/xournalpp/releases/tag/nightly)

### 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

Xournalpp 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

<div id="macosDownloadsContainer">
<a class="xournalppButton" href="{{downloads.macos.stable}}">Stable (Recommended)</a>
<a class="xournalppButton" href="{{downloads.nightly}}">Nightly</a>
<a class="xournalppButton" href="{{downloads.default}}">Other versions</a>
</div>

> In case of downloading other version than stable one, remember to download the `macos` version.
Mazurel marked this conversation as resolved.
Show resolved Hide resolved

## Installing program

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

Just download the archive and run unzipped executable.
Mazurel marked this conversation as resolved.
Show resolved Hide resolved
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 guide

## General information

Xournalpp 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

<div id="windowsDownloadsContainer">
<a class="xournalppButton" href="{{downloads.windows.stable}}">Stable (Recommended)</a>
<a class="xournalppButton" href="{{downloads.nightly}}">Nightly</a>
<a class="xournalppButton" href="{{downloads.default}}">Other versions</a>
</div>

> In case of downloading other version than stable one, remember to download the `windows` version.
Mazurel marked this conversation as resolved.
Show resolved Hide resolved

## 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 !

21 changes: 20 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ remote_branch: master
edit_uri: https://github.com/xournalpp/xournalpp.github.io/edit/site/docs
nav:
- Home: index.md
- Install: installation.md
- Installation:
- OS selection: installation/general.md
- Windows: installation/windows.md
- MacOS: installation/macos.md
- Linux: installation/linux.md
- Guide:
- Overview: guide/overview.md
- Configuration: guide/config.md
Expand Down Expand Up @@ -38,12 +42,27 @@ theme:
- navigation.tabs
- toc.integrate

# Custom styles
extra_css:
- css/buttons.css

#Enable macros
plugins:
- search
- macros

extra:
downloads:
default: "https://github.com/xournalpp/xournalpp/releases"
nightly: "https://github.com/xournalpp/xournalpp/releases/tag/nightly"
windows:
stable: "https://github.com/xournalpp/xournalpp/releases/download/1.0.20/xournalpp-1.0.20-windows.zip"
macos:
stable: "https://github.com/xournalpp/xournalpp/releases/download/1.0.20/xournalpp-1.0.20-macos.zip"
linux:
flatpak: "https://flathub.org/apps/details/com.github.xournalpp.xournalpp"
appimage: "https://github.com/xournalpp/xournalpp/releases/download/1.0.20/xournalpp-1.0.20-x86_64.AppImage"
Mazurel marked this conversation as resolved.
Show resolved Hide resolved
snap: "https://snapcraft.io/xournalpp"
version:
latest_stable: "1.0.20"
latest_unstable: "1.1.0+dev"
Expand Down