Converted index docs to md

This commit is contained in:
2019-05-02 15:22:48 -06:00
parent d525364b28
commit 4ab41277d4
2 changed files with 56 additions and 49 deletions

View File

@@ -1,49 +0,0 @@
---
layout: default
title: Documentation
---
<br />
<br />
<h3>Documentation</h3><br />
<p>It's a fact that one of the biggest problems with today's software is lack of good documentation, or any
documentation for that matter. Programmers generally don't have a lot of time to document their work, and the things
they do document are usually oriented towards other programmers. While we can appreciate the programmers point of view,
we feel it's necessary to cater to a larger audience (i.e our users) by providing clear, concise information on how to
use our software. The sections below will bring all of these pieces of information together for you.</p>
<p>Before you get started with Window Maker, you need to have an understanding of how to make use of the documentation
that comes with the source distribution. The main objective to using documentation is to <strong>understand</strong>
it, which coincidentally requires that you <strong>read</strong> it. A common mistake is for new or novice users to
overlook this information, leading them to frustration and a bad first impression. Please take a moment to peruse the
sections below, which should make the experience of learning Window Maker a more pleasant one.</p>
<ul>
<li><a href="installation.html">Installation Basics</a></li>
<li><a href="wmaker_install.html">Window Maker Compilation and Installation</a></li>
<li><a href="wmaker_i18n.html">Window Maker Internationalisation</a></li>
<li><a href="guidedtour/index.html">Guided Tour</a></li>
<li><a href="guide_toc.html">User Guide</a></li>
<!-- <li><a href="desktop.php">Desktop/X Integration</a></li> -->
<li><a href="FAQ.html">FAQ</a></li>
<li><a href="wings.html">WINGs</a></li>
</ul>
<h3>Very frequently asked question </h3>
<h2> Can I easily mount my external drives or connect to the internet with Window Maker?</h2>
<p> Yes, you can. Mounting external media is not the problem of a window manager to solve, but
a tipical Window Maker user can mount external media just as easily as any other desktop user.
If you use a dockapp like <a href="https://github.com/raorn/wmvolman">wmvolman</a> or
<a href="http://sourceforge.net/projects/wmudmount">wmudmount</a> you are just a click away from
having your external media mounted on /media/VOLUME_LABEL.</p>
<p> And you can just as easily manage your network connections using the standard <code>nm-applet</code> running
in a system tray like <a href="http://sourceforge.net/projects/wmsystemtray">wmsystemtray</a> on your dock.</p>
<div align="center"><img src="/img/essential_dockapps.png" alt="Essential dockapps" width="66" height="135" /><div>wmvolman and wmsystemtray with nm-applet</div></div>

56
docs/index.md Normal file
View File

@@ -0,0 +1,56 @@
---
layout: default
title: Documentation
---
Documentation
=============
It's a fact that one of the biggest problems with today's software is lack of
good documentation, or any documentation for that matter. Programmers generally
don't have a lot of time to document their work, and the things they do document
are usually oriented towards other programmers. While we can appreciate the
programmers point of view, we feel it's necessary to cater to a larger audience
(i.e our users) by providing clear, concise information on how to use our
software. The sections below will bring all of these pieces of information
together for you.
Before you get started with Window Maker, you need to have an understanding of
how to make use of the documentation that comes with the source distribution.
The main objective to using documentation is to **understand** it, which
coincidentally requires that you **read** it. A common mistake is for new or
novice users to overlook this information, leading them to frustration and a bad
first impression. Please take a moment to peruse the sections below, which
should make the experience of learning Window Maker a more pleasant one.
- [Installation Basics](installation.html)
- [Window Maker Compilation and Installation](wmaker_install.html)
- [Window Maker Internationalisation](wmaker_i18n.html)
- [Guided Tour](guidedtour/index.html)
- [User Guide](guide_toc.html)
- [Desktop/X Integration](desktop.php)
- [FAQ](FAQ.html)
- [WINGs](wings.html)
Very frequently asked question
------------------------------
- **Can I easily mount my external drives or connect to the internet with Window
Maker?**
Yes, you can. Mounting external media is not the problem of a window manager
to solve, but a tipical Window Maker user can mount external media just as
easily as any other desktop user. If you use a dockapp like
[wmvolman](https://github.com/raorn/wmvolman) or
[wmudmount](http://sourceforge.net/projects/wmudmount) you are just a
click away from having your external media mounted on `/media/VOLUME_LABEL`.
And you can just as easily manage your network connections using the standard
`nm-applet` running in a system tray like
[wmsystemtray](http://sourceforge.net/projects/wmsystemtray) on your dock.
![Default Window Maker config](/img/essential_dockapps.png)
{:.screenshot .center}
wmvolman and wmsystemtray with nm-applet
{:.caption .center}