Skip to content

Commit

Permalink
[DOCS] Split homepage
Browse files Browse the repository at this point in the history
This commit splits the documentation homepage into docs/index.rst (containing only an `include` directive and the `toctree` directives) and docs/general/home.rst (which includes the main content of the page and is included by the `include` directive in docs/index.rst).
  • Loading branch information
ZelnickB committed Aug 24, 2020
1 parent fd63b50 commit cfc5145
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 33 deletions.
27 changes: 27 additions & 0 deletions docs/general/home.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
**************************************
Welcome to the Aluminum Documentation.
**************************************

What is Aluminum?
=================

Aluminum is a lightweight web server written entirely in `Node.js <https://www.nodejs.org>`_, "an asynchronous event-driven JavaScript runtime ... designed to build scalable network applications." It includes not only a traditional static/dynamic web server, but also various other features that simplify the web development process, such as an authentication server and a network-based cryptography server.

Why Aluminum?
=============

Aluminum is simple to install and easy to use. Simply clone the git repository, install the dependencies automatically with ``yarn``, and copy the default configuration files into the higher level directory. Starting the web server is as simple as typing ``yarn run start`` into your terminal.

.. seealso:: See the installation guide for a detailed tutorial on getting started with Aluminum.

It also offers several unique and useful features:

* **Highly Customizable:** Use an official extension, a community-contributed one, or make your own.
* **Integrated Authentication Server:** Verify end users' identity without leaving the Aluminum platform.
* **PHP support:** If you're uncomfortable using Node.js for server-side scripting, Aluminum is also compatible with PHP.
* **And more:** Remote system resource monitor, network based time synchronization, math rendering, simplified cryptography, etc.

Navigating the Documentation
============================

To navigate the documentation, use the sidebar to the left. To return to this page at any time, click or tap on the Aluminum logo at the top of the sidebar.
35 changes: 2 additions & 33 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,43 +1,12 @@
.. Aluminum documentation master file, created by
sphinx-quickstart on Tue Jun 30 18:15:03 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
**************************************
Welcome to the Aluminum Documentation.
**************************************

What is Aluminum?
=================

Aluminum is a lightweight web server written entirely in `Node.js <https://www.nodejs.org>`_, "an asynchronous event-driven JavaScript runtime ... designed to build scalable network applications." It includes not only a traditional static/dynamic web server, but also various other features that simplify the web development process, such as an authentication server and a network-based cryptography server.

Why Aluminum?
=============

Aluminum is simple to install and easy to use. Simply clone the git repository, install the dependencies automatically with ``yarn``, and copy the default configuration files into the higher level directory. Starting the web server is as simple as typing ``yarn run start`` into your terminal.

.. seealso:: See the installation guide for a detailed tutorial on getting started with Aluminum.

It also offers several unique and useful features:

* **Highly Customizable:** Use an official extension, a community-contributed one, or make your own.
* **Integrated Authentication Server:** Verify end users' identity without leaving the Aluminum platform.
* **PHP support:** If you're uncomfortable using Node.js for server-side scripting, Aluminum is also compatible with PHP.
* **And more:** Remote system resource monitor, network based time synchronization, math rendering, simplified cryptography, etc.

Navigating the Documentation
============================

To navigate the documentation, use the sidebar to the left. To return to this page at any time, click or tap on the Aluminum logo at the top of the sidebar.

.. include:: ./general/home.rst

.. toctree::
:maxdepth: 2
:caption: General Documentation
:numbered:
:hidden:

Welcome Page <general/home>
general/ports


Expand Down

0 comments on commit cfc5145

Please sign in to comment.