-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
Showing
2 changed files
with
29 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters