Skip to content

Commit

Permalink
Tidy up docs home slightly
Browse files Browse the repository at this point in the history
  • Loading branch information
zvecr committed Dec 26, 2020
1 parent 20a169c commit 35a9425
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 11,008 deletions.
7 changes: 5 additions & 2 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,18 @@ module.exports = {
title: 'QMK MSYS',
description: 'The one-click installer for MSYS2 + QMK CLI',
themeConfig: {
nav: [
{ text: 'Discord', link: 'https://discord.gg/Uq7gcHh' },
{ text: 'GitHub', link: 'https://github.com/qmk/qmk_distro_msys' }
],
logo: '/logo.png',
search: false,
lastUpdated: false,
sidebar: [
'/',
'/guide',
'/faq',
'/dev',
],
},
plugins: [ 'vuepress-plugin-medium-zoom'],
plugins: ['vuepress-plugin-medium-zoom'],
};
8 changes: 6 additions & 2 deletions docs/.vuepress/styles/index.styl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@
color: white;
background-color: #3d87ce;
padding: .8rem 1.6rem;
margin: 0 0.8rem;
border-radius: 4px;
transition: background-color .1s ease;
box-sizing: border-box;
border-bottom: 1px solid #3d87ce;
border-bottom: 1px solid #3d87ce;

.button.secondary
background-color: #ff793f;
border-bottom: 1px solid #ff793f;
15 changes: 11 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
---
title: Home
home: true
heroImage: /logo.png
footer: This project is maintained by QMK collaborators and contributors like you!
---

<p align="center">
<a class="button" href="./guide.html">Get Started →</a>
<a class="button secondary" href="https://github.com/qmk/qmk_distro_msys/releases">Latest Version ↓</a>
</p>

::: warning STATUS: BETA
USE AT YOUR OWN RISK
:::

Want to get started with [QMK Firmware](https://qmk.fm) quickly? Running Windows 8/10 and want to avoid installation headaches? Look no further!

<img :src="$withBase('/terminal.png')" alt="terminal example" style="display: block; margin: 0 auto;">

Bundling MSYS2 + QMK CLI together, this installer package aims to give you a QMK build environment with as little effort as possible.

<p align="center">
<a class="button" href="https://github.com/qmk/qmk_distro_msys/releases">Latest Version →</a>
</p>
<img :src="$withBase('/terminal.png')" alt="terminal example" style="display: block; margin: 0 auto;">

<br>
Loading

0 comments on commit 35a9425

Please sign in to comment.