From 9a6f2ea5629e3cefd4f1656c7e9cf7be0a66c9dd Mon Sep 17 00:00:00 2001 From: gryf Date: Sat, 4 May 2019 14:38:21 -0600 Subject: [PATCH] Converted docs index from md to rst --- docs/index.md | 56 -------------------------------------------------- docs/index.rst | 55 +++++++++++++++++++++++++++++++++++++++++++++++++ style.css | 9 ++++++++ 3 files changed, 64 insertions(+), 56 deletions(-) delete mode 100644 docs/index.md create mode 100644 docs/index.rst diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index ae60251..0000000 --- a/docs/index.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -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} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..b26976a --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,55 @@ +--- +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 `_ +- `Window Maker Compilation and Installation `_ +- `Window Maker Internationalisation `_ +- `Guided Tour `_ +- `User Guide `_ +- `Desktop/X Integration `_ +- `FAQ `_ +- `WINGs `_ + +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 `_ or + `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 + `_ on your dock. + + .. figure:: /img/essential_dockapps.png + :alt: essential dockapps + + wmvolman and wmsystemtray with nm-applet diff --git a/style.css b/style.css index f313597..a25790c 100644 --- a/style.css +++ b/style.css @@ -39,6 +39,8 @@ pre { } p.center {text-align: center} +p.caption {text-align: center} + p.screenshot a img { border: 1px solid black; @@ -77,6 +79,13 @@ div.gallery img { clear: left; } +div.figure img { + display: block; + border: 1px solid black; + box-shadow: 3px 7px 7px #606060; + margin: 0 auto; +} + /* logo */ header h1 a { font-family: "DejaVu Sans", sans-serif;